SCH_SCREEN Class Reference

#include <sch_screen.h>

Inheritance diagram for SCH_SCREEN:

Public Member Functions
	SCH_SCREEN (EDA_ITEM *aParent=nullptr)
	~SCH_SCREEN ()
SCHEMATIC *	Schematic () const
EE_RTREE &	Items ()
	Gets the full RTree, usually for iterating. More...
const EE_RTREE &	Items () const
bool	IsEmpty () const
bool	HasItems (KICAD_T aItemType) const
bool	HasSheets () const
virtual wxString	GetClass () const override
	Return the class name. More...
void	SetFileFormatVersionAtLoad (int aVersion)
int	GetFileFormatVersionAtLoad () const
const PAGE_INFO &	GetPageSettings () const
void	SetPageSettings (const PAGE_INFO &aPageSettings)
void	SetFileName (const wxString &aFileName)
	Set the file name for this screen to aFileName. More...
const wxString &	GetFileName () const
void	SetFileReadOnly (bool aIsReadOnly)
bool	IsReadOnly () const
void	SetFileExists (bool aFileExists)
bool	FileExists () const
const wxPoint &	GetAuxOrigin () const
void	SetAuxOrigin (const wxPoint &aPosition)
const TITLE_BLOCK &	GetTitleBlock () const
void	SetTitleBlock (const TITLE_BLOCK &aTitleBlock)
void	DecRefCount ()
void	IncRefCount ()
int	GetRefCount () const
void	SetConnectivityDirty ()
std::vector< SCH_SHEET_PATH > &	GetClientSheetPaths ()
	Return the number of times this screen is used. More...
void	Append (SCH_ITEM *aItem)
void	Append (SCH_SCREEN *aScreen)
	Copy the contents of aScreen into this SCH_SCREEN object. More...
void	Clear (bool aFree=true)
	Delete all draw items and clears the project settings. More...
void	FreeDrawList ()
	Free all the items from the schematic associated with the screen. More...
SCH_ITEM *	GetItem (const wxPoint &aPosition, int aAccuracy=0, KICAD_T aType=SCH_LOCATE_ANY_T) const
	Check aPosition within a distance of aAccuracy for items of type aFilter. More...
void	UpdateSymbolLinks (REPORTER *aReporter=nullptr)
	Initialize the LIB_SYMBOL reference for each SCH_SYMBOL found in this schematic from the project SYMBOL_LIB_TABLE. More...
void	UpdateLocalLibSymbolLinks ()
	Initialize the LIB_SYMBOL reference for each SCH_SYMBOL found in this schematic with the local project library symbols. More...
void	Print (const RENDER_SETTINGS *aSettings)
	Print all the items in the screen to aDC. More...
void	Plot (PLOTTER *aPlotter) const
	Plot all the schematic objects to aPlotter. More...
bool	Remove (SCH_ITEM *aItem)
	Remove aItem from the schematic associated with this screen. More...
void	Update (SCH_ITEM *aItem)
	Update aItem's bounding box in the tree. More...
void	DeleteItem (SCH_ITEM *aItem)
	Removes aItem from the linked list and deletes the object. More...
bool	CheckIfOnDrawList (const SCH_ITEM *aItem) const
void	TestDanglingEnds (const SCH_SHEET_PATH *aPath=nullptr, std::function< void(SCH_ITEM *)> *aChangedHandler=nullptr) const
	Test all of the connectable objects in the schematic for unused connection points. More...
std::set< SCH_ITEM * >	MarkConnections (SCH_LINE *aSegment)
	Return all wires and junctions connected to aSegment which are not connected any symbol pin. More...
void	ClearDrawingState ()
	Clear the state flags of all the items in the screen. More...
size_t	CountConnectedItems (const wxPoint &aPos, bool aTestJunctions) const
bool	IsJunction (const wxPoint &aPosition) const
	Test if a junction is required for the items at aPosition on the screen. More...
bool	IsExplicitJunction (const wxPoint &aPosition) const
	Indicates that a junction dot is necessary at the given location. More...
bool	IsExplicitJunctionNeeded (const wxPoint &aPosition) const
	Indicates that a junction dot is necessary at the given location, and does not yet exist. More...
bool	IsExplicitJunctionAllowed (const wxPoint &aPosition) const
	Indicates that a juction dot may be placed at the given location. More...
bool	IsTerminalPoint (const wxPoint &aPosition, int aLayer) const
	Test if aPosition is a connection point on aLayer. More...
LIB_PIN *	GetPin (const wxPoint &aPosition, SCH_SYMBOL **aSymbol=nullptr, bool aEndPointOnly=false) const
	Test the screen for a symbol pin item at aPosition. More...
SCH_SHEET_PIN *	GetSheetPin (const wxPoint &aPosition) const
	Test the screen if aPosition is a sheet label object. More...
void	ClearAnnotation (SCH_SHEET_PATH *aSheetPath)
	Clear the annotation for the symbols in aSheetPath on the screen. More...
void	EnsureAlternateReferencesExist ()
	For screens shared by many sheetpaths (complex hierarchies): to be able to clear or modify any reference related sharing this screen (i.e. More...
void	GetHierarchicalItems (std::vector< SCH_ITEM * > *aItems) const
	Add all schematic sheet and symbol objects in the screen to aItems. More...
void	GetSheets (std::vector< SCH_ITEM * > *aItems) const
	Similar to Items().OfType( SCH_SHEET_T ), but return the sheets in a deterministic order (L-R, T-B) for sheet numbering. More...
SCH_LINE *	GetLine (const wxPoint &aPosition, int aAccuracy=0, int aLayer=LAYER_NOTES, SCH_LINE_TEST_T aSearchType=ENTIRE_LENGTH_T) const
	Return a line item located at aPosition. More...
SCH_LINE *	GetWire (const wxPoint &aPosition, int aAccuracy=0, SCH_LINE_TEST_T aSearchType=ENTIRE_LENGTH_T) const
SCH_LINE *	GetBus (const wxPoint &aPosition, int aAccuracy=0, SCH_LINE_TEST_T aSearchType=ENTIRE_LENGTH_T) const
SCH_TEXT *	GetLabel (const wxPoint &aPosition, int aAccuracy=0) const
	Return a label item located at aPosition. More...
std::map< wxString, LIB_SYMBOL * > &	GetLibSymbols ()
	Fetch a list of unique LIB_SYMBOL object pointers required to properly render each SCH_SYMBOL in this schematic. More...
const std::map< wxString, LIB_SYMBOL * > &	GetLibSymbols () const
void	AddLibSymbol (LIB_SYMBOL *aLibSymbol)
	Add aLibSymbol to the library symbol map. More...
void	AddBusAlias (std::shared_ptr< BUS_ALIAS > aAlias)
	Add a bus alias definition (and transfers ownership of the pointer). More...
void	ClearBusAliases ()
	Remove all bus alias definitions. More...
std::unordered_set< std::shared_ptr< BUS_ALIAS > >	GetBusAliases () const
	Return a list of bus aliases defined in this screen. More...
const std::vector< SYMBOL_INSTANCE_REFERENCE > &	GetSymbolInstances () const
const std::vector< SCH_SHEET_INSTANCE > &	GetSheetInstances () const
const KIID &	GetUuid () const
void	AssignNewUuid ()
void	InitDataPoints (const wxSize &aPageSizeInternalUnits)
void	SetContentModified (bool aModified=true)
bool	IsContentModified () const
int	GetPageCount () const
void	SetPageCount (int aPageCount)
int	GetVirtualPageNumber () const
void	SetVirtualPageNumber (int aPageNumber)
const wxString &	GetPageNumber () const
void	SetPageNumber (const wxString &aPageNumber)
KICAD_T	Type () const
	Returns the type of object. More...
EDA_ITEM *	GetParent () const
virtual void	SetParent (EDA_ITEM *aParent)
bool	IsModified () const
bool	IsNew () const
bool	IsMoving () const
bool	IsDragging () const
bool	IsWireImage () const
bool	IsSelected () const
bool	IsEntered () const
bool	IsResized () const
bool	IsBrightened () const
void	SetWireImage ()
void	SetSelected ()
void	SetBrightened ()
void	ClearSelected ()
void	ClearBrightened ()
void	SetModified ()
int	GetState (EDA_ITEM_FLAGS type) const
void	SetState (EDA_ITEM_FLAGS type, bool state)
EDA_ITEM_FLAGS	GetStatus () const
void	SetStatus (EDA_ITEM_FLAGS aStatus)
void	SetFlags (EDA_ITEM_FLAGS aMask)
void	ClearFlags (EDA_ITEM_FLAGS aMask=EDA_ITEM_ALL_FLAGS)
EDA_ITEM_FLAGS	GetFlags () const
bool	HasFlag (EDA_ITEM_FLAGS aFlag) const
EDA_ITEM_FLAGS	GetEditFlags () const
void	ClearTempFlags ()
void	ClearEditFlags ()
virtual bool	IsType (const 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 bool	HitTest (const wxPoint &aPosition, int aAccuracy=0) const
	Test if aPosition is inside or on the boundary of this item. More...
virtual bool	HitTest (const EDA_RECT &aRect, bool aContained, int aAccuracy=0) const
	Test if aRect intersects this item. More...
virtual const EDA_RECT	GetBoundingBox () const
	Return the orthogonal bounding box of this object for display purposes. More...
virtual wxPoint	GetPosition () const
virtual void	SetPosition (const wxPoint &aPos)
virtual const wxPoint	GetFocusPosition () const
	Similar to GetPosition, but allows items to return their visual center rather than their anchor. More...
virtual EDA_ITEM *	Clone () const
	Create a duplicate of this item with linked list members set to NULL. More...
virtual SEARCH_RESULT	Visit (INSPECTOR inspector, void *testData, const KICAD_T scanTypes[])
	May be re-implemented for each derived class in order to handle all the types given by its member data. More...
virtual wxString	GetSelectMenuText (EDA_UNITS aUnits) const
	Return the text to display to be used in the selection clarification context menu when multiple items are found at the current cursor position. More...
virtual BITMAPS	GetMenuImage () const
	Return a pointer to an image to be used in menus. More...
virtual bool	Matches (const wxFindReplaceData &aSearchData, void *aAuxData) const
	Compare the item against the search criteria in aSearchData. More...
virtual bool	Replace (const wxFindReplaceData &aSearchData, void *aAuxData=nullptr)
	Perform a text replace using the find and replace criteria in aSearchData on items that support text find and replace. More...
virtual bool	IsReplaceable () const
	Override this method in any derived object that supports test find and replace. More...
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	ClearViewPrivData ()
bool	Set (PROPERTY_BASE *aProperty, wxAny &aValue)
template<typename T >
bool	Set (PROPERTY_BASE *aProperty, T aValue)
template<typename T >
bool	Set (const wxString &aProperty, T aValue)
wxAny	Get (PROPERTY_BASE *aProperty)
template<typename T >
T	Get (PROPERTY_BASE *aProperty)
template<typename T >
boost::optional< T >	Get (const wxString &aProperty)

Static Public Member Functions
static bool	ClassOf (const EDA_ITEM *aItem)
template<class T >
static SEARCH_RESULT	IterateForward (std::deque< T > &aList, INSPECTOR inspector, void *testData, const KICAD_T scanTypes[])
	This changes first parameter to avoid the DList and use the main queue instead. More...
template<class T >
static SEARCH_RESULT	IterateForward (std::vector< T > &aList, INSPECTOR inspector, void *testData, const KICAD_T scanTypes[])
	Change first parameter to avoid the DList and use std::vector instead. More...
static bool	Replace (const wxFindReplaceData &aSearchData, wxString &aText)
	Perform a text replace on aText using the find and replace criteria in aSearchData on items that support text find and replace. More...
static bool	Sort (const EDA_ITEM *aLeft, const EDA_ITEM *aRight)
	Helper function to be used by the C++ STL sort algorithm for sorting a STL container of EDA_ITEM pointers. More...

Public Attributes
double	m_LastZoomLevel
	last value for the zoom level, useful in Eeschema when changing the current displayed sheet to reuse the same zoom level when back to the sheet using this screen More...
wxPoint	m_DrawOrg
	offsets for drawing the circuit on the screen More...
VECTOR2D	m_LocalOrigin
	Relative Screen cursor coordinate (on grid) in user units. More...
wxPoint	m_StartVisu
	Coordinates in drawing units of the current view position (upper left corner of device) More...
bool	m_Center
	Center on screen. More...
VECTOR2D	m_ScrollCenter
	Current scroll center point in logical units. More...
const KIID	m_Uuid

Static Public Attributes
static wxString	m_DrawingSheetFileName
	the name of the drawing sheet file, or empty to use the default drawing sheet More...

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

Protected Attributes
int	m_pageCount
	The number of BASE_SCREEN objects in this design. More...
int	m_virtualPageNumber
	An integer based page number used for printing a range of pages. More...
wxString	m_pageNumber
	A user defined string page number used for printing and plotting. More...
EDA_ITEM_FLAGS	m_status
EDA_ITEM *	m_parent
	Linked list: Link (parent struct) More...
bool	m_forceVisible
EDA_ITEM_FLAGS	m_flags

Private Member Functions
bool	doIsJunction (const wxPoint &aPosition, bool aBreakCrossings, bool *aHasExplicitJunctionDot, bool *aHasBusEntry) const
void	clearLibSymbols ()

Private Attributes
friend	SCH_EDIT_FRAME
friend	SCH_SEXPR_PARSER
friend	SCH_SEXPR_PLUGIN
wxString	m_fileName
int	m_fileFormatVersionAtLoad
int	m_refCount
std::vector< SCH_SHEET_PATH >	m_clientSheetPathList
	The list of sheet paths sharing this screen. More...
PAGE_INFO	m_paper
TITLE_BLOCK	m_titles
wxPoint	m_aux_origin
EE_RTREE	m_rtree
int	m_modification_sync
bool	m_zoomInitialized
bool	m_isReadOnly
	Read only status of the screen file. More...
bool	m_fileExists
std::unordered_set< std::shared_ptr< BUS_ALIAS > >	m_aliases
	List of bus aliases stored in this screen. More...
std::map< wxString, LIB_SYMBOL * >	m_libSymbols
	Library symbols required for this schematic. More...
std::vector< SYMBOL_INSTANCE_REFERENCE >	m_symbolInstances
	The list of symbol instances loaded from the schematic file. More...
std::vector< SCH_SHEET_INSTANCE >	m_sheetInstances
KIID	m_uuid
	A unique identifier for each schematic file. More...

Detailed Description

Definition at line 93 of file sch_screen.h.

Constructor & Destructor Documentation

SCH_SCREEN()

SCH_SCREEN::SCH_SCREEN

(

EDA_ITEM *

aParent = nullptr

)

Definition at line 66 of file sch_screen.cpp.

 :
 BASE_SCREEN( aParent, SCH_SCREEN_T ),
 m_fileFormatVersionAtLoad( 0 ),
 m_paper( wxT( "A4" ) ),
 m_isReadOnly( false ),
 m_fileExists( false )
{
 m_modification_sync = 0;
 m_refCount = 0;
 m_zoomInitialized = false;
 m_LastZoomLevel = 1.0;

 // Suitable for schematic only. For symbol_editor and viewlib, must be set to true
 m_Center = false;

 InitDataPoints( m_paper.GetSizeIU() );
}

References BASE_SCREEN::InitDataPoints(), BASE_SCREEN::m_Center, m_LastZoomLevel, m_modification_sync, m_paper, m_refCount, and m_zoomInitialized.

~SCH_SCREEN()

SCH_SCREEN::~SCH_SCREEN

(

)

Definition at line 85 of file sch_screen.cpp.

{
 clearLibSymbols();
 FreeDrawList();
}

References clearLibSymbols(), and FreeDrawList().

Member Function Documentation

AddBusAlias()

void SCH_SCREEN::AddBusAlias

(

std::shared_ptr< BUS_ALIAS >

aAlias

)

Add a bus alias definition (and transfers ownership of the pointer).

Definition at line 1148 of file sch_screen.cpp.

{
 m_aliases.insert( aAlias );
}

References m_aliases.

Referenced by CADSTAR_SCH_ARCHIVE_LOADER::loadBusses(), SCH_LEGACY_PLUGIN::LoadContent(), and SCH_SEXPR_PARSER::parseBusAlias().

AddLibSymbol()

void SCH_SCREEN::AddLibSymbol

(

LIB_SYMBOL *

aLibSymbol

)

Add aLibSymbol to the library symbol map.

The symbol is mapped to the result of LIB_ID::Format(). If a symbol is already mapped, the existing symbol is replaced with aLibSymbol. The screen object takes ownership of the pointer.

Parameters

aLibSymbol

A pointer the LIB_SYMBOL to be added to the symbol map.

Definition at line 1130 of file sch_screen.cpp.

{
 wxCHECK( aLibSymbol, /* void */ );

 wxString libSymbolName = aLibSymbol->GetLibId().Format().wx_str();

 auto it = m_libSymbols.find( libSymbolName );

 if( it != m_libSymbols.end() )
 {
 delete it->second;
 m_libSymbols.erase( it );
 }

 m_libSymbols[libSymbolName] = aLibSymbol;
}

References LIB_ID::Format(), LIB_SYMBOL::GetLibId(), m_libSymbols, and UTF8::wx_str().

Referenced by SCH_SEXPR_PARSER::ParseSchematic().

Append() [1/2]

void SCH_SCREEN::Append

(

SCH_ITEM *

aItem

)

Definition at line 146 of file sch_screen.cpp.

{
 if( aItem->Type() != SCH_SHEET_PIN_T && aItem->Type() != SCH_FIELD_T )
 {
 // Ensure the item can reach the SCHEMATIC through this screen
 aItem->SetParent( this );

 if( aItem->Type() == SCH_SYMBOL_T )
 {
 SCH_SYMBOL* symbol = static_cast<SCH_SYMBOL*>( aItem );

 if( symbol->GetLibSymbolRef() )
 {
 symbol->GetLibSymbolRef()->GetDrawItems().sort();

 auto it = m_libSymbols.find( symbol->GetSchSymbolLibraryName() );

 if( it == m_libSymbols.end() || !it->second )
 {
 m_libSymbols[symbol->GetSchSymbolLibraryName()] =
 new LIB_SYMBOL( *symbol->GetLibSymbolRef() );
 }
 else
 {
 // The original library symbol may have changed since the last time
 // it was added to the schematic. If it has changed, then a new name
 // must be created for the library symbol list to prevent all of the
 // other schematic symbols referencing that library symbol from changing.
 LIB_SYMBOL* foundSymbol = it->second;

 foundSymbol->GetDrawItems().sort();

 if( *foundSymbol != *symbol->GetLibSymbolRef() )
 {
 int cnt = 1;
 wxString newName;

 newName.Printf( "%s_%d", symbol->GetLibId().GetUniStringLibItemName(),
 cnt );

 while( m_libSymbols.find( newName ) != m_libSymbols.end() )
 {
 cnt += 1;
 newName.Printf( "%s_%d", symbol->GetLibId().GetUniStringLibItemName(),
 cnt );
 }

 // Update the schematic symbol library link as this symbol only exists
 // in the schematic.
 symbol->SetSchSymbolLibraryName( newName );

 LIB_SYMBOL* newLibSymbol = new LIB_SYMBOL( *symbol->GetLibSymbolRef() );
 LIB_ID newLibId( wxEmptyString, newName );

 newLibSymbol->SetLibId( newLibId );
 newLibSymbol->SetName( newName );
 symbol->SetLibSymbol( newLibSymbol->Flatten().release() );
 m_libSymbols[newName] = newLibSymbol;
 }
 }
 }
 }

 m_rtree.insert( aItem );
 --m_modification_sync;
 }
}

References LIB_SYMBOL::Flatten(), LIB_SYMBOL::GetDrawItems(), SCH_SYMBOL::GetLibId(), SCH_SYMBOL::GetLibSymbolRef(), SCH_SYMBOL::GetSchSymbolLibraryName(), LIB_ID::GetUniStringLibItemName(), EE_RTREE::insert(), m_libSymbols, m_modification_sync, m_rtree, SCH_FIELD_T, SCH_SHEET_PIN_T, SCH_SYMBOL_T, LIB_SYMBOL::SetLibId(), SCH_SYMBOL::SetLibSymbol(), LIB_SYMBOL::SetName(), EDA_ITEM::SetParent(), SCH_SYMBOL::SetSchSymbolLibraryName(), MULTIVECTOR< T, FIRST_TYPE_VAL, LAST_TYPE_VAL >::sort(), and EDA_ITEM::Type().

Referenced by SCH_EAGLE_PLUGIN::addBusEntries(), SCH_EAGLE_PLUGIN::addImplicitConnections(), Append(), CONNECTION_GRAPH::ercCheckFloatingWires(), CONNECTION_GRAPH::ercCheckHierSheets(), CONNECTION_GRAPH::ercCheckLabels(), CONNECTION_GRAPH::ercCheckMultipleDrivers(), CONNECTION_GRAPH::ercCheckNoConnects(), CADSTAR_SCH_ARCHIVE_LOADER::loadBusses(), SCH_LEGACY_PLUGIN::LoadContent(), CADSTAR_SCH_ARCHIVE_LOADER::loadHierarchicalSheetPins(), SCH_EAGLE_PLUGIN::loadInstance(), SCH_EAGLE_PLUGIN::loadSchematic(), CADSTAR_SCH_ARCHIVE_LOADER::loadSchematicSymbol(), CADSTAR_SCH_ARCHIVE_LOADER::loadSchematicSymbolInstances(), SCH_EAGLE_PLUGIN::loadSegments(), SCH_EAGLE_PLUGIN::loadSheet(), CADSTAR_SCH_ARCHIVE_LOADER::loadSheetAndChildSheets(), SCH_EDIT_FRAME::LoadSheetFromFile(), DIALOG_ERC::OnRunERCClick(), DIALOG_SHEET_PROPERTIES::onSheetFilenameChanged(), SCH_ALTIUM_PLUGIN::ParseBezier(), SCH_ALTIUM_PLUGIN::ParseBus(), SCH_ALTIUM_PLUGIN::ParseBusEntry(), SCH_ALTIUM_PLUGIN::ParseComponent(), SCH_ALTIUM_PLUGIN::ParseImage(), SCH_ALTIUM_PLUGIN::ParseJunction(), SCH_ALTIUM_PLUGIN::ParseLabel(), SCH_ALTIUM_PLUGIN::ParseLine(), SCH_ALTIUM_PLUGIN::ParseNetLabel(), SCH_ALTIUM_PLUGIN::ParseNoERC(), SCH_ALTIUM_PLUGIN::ParseNote(), SCH_ALTIUM_PLUGIN::ParsePolygon(), SCH_ALTIUM_PLUGIN::ParsePolyline(), SCH_ALTIUM_PLUGIN::ParsePort(), SCH_ALTIUM_PLUGIN::ParsePowerPort(), SCH_ALTIUM_PLUGIN::ParseRectangle(), SCH_ALTIUM_PLUGIN::ParseRoundRectangle(), SCH_SEXPR_PARSER::ParseSchematic(), SCH_ALTIUM_PLUGIN::ParseSheetSymbol(), SCH_ALTIUM_PLUGIN::ParseTextFrame(), SCH_ALTIUM_PLUGIN::ParseWire(), SCH_EDITOR_CONTROL::Paste(), DIALOG_CHANGE_SYMBOLS::processSymbol(), SCH_EDIT_FRAME::ResolveERCExclusions(), SCH_EDIT_FRAME::SaveSymbolToSchematic(), ERC_TESTER::TestDuplicateSheetNames(), ERC_TESTER::TestMultiunitFootprints(), ERC_TESTER::TestMultUnitPinConflicts(), ERC_TESTER::TestSimilarLabels(), ERC_TESTER::TestTextVars(), DIALOG_SYMBOL_PROPERTIES::TransferDataFromWindow(), Update(), and UpdateSymbolLinks().

Append() [2/2]

void SCH_SCREEN::Append

(

SCH_SCREEN *

aScreen

)

Copy the contents of aScreen into this SCH_SCREEN object.

Warning

The contents of Screen cannot contain any duplicate sheet names or any hierarchy recursion issues or bad things will happen.

Parameters

aScreen

is the screen to append to this one.

Returns

false if there are any duplicate sheet names or any hierarchy recursion issues the calling this method or KiCad will crash.

Definition at line 215 of file sch_screen.cpp.

{
 wxCHECK_RET( aScreen, "Invalid screen object." );

 // No need to descend the hierarchy. Once the top level screen is copied, all of its
 // children are copied as well.
 for( SCH_ITEM* aItem : aScreen->m_rtree )
 Append( aItem );

 aScreen->Clear( false );
}

References Append(), Clear(), and m_rtree.

AssignNewUuid()

void SCH_SCREEN::AssignNewUuid ( )

inline

Definition at line 498 of file sch_screen.h.

{ m_uuid = KIID(); }

References m_uuid.

Referenced by SCH_EDIT_FRAME::SaveProject().

CheckIfOnDrawList()

bool SCH_SCREEN::CheckIfOnDrawList

(

const SCH_ITEM *

aItem

)

const

Definition at line 336 of file sch_screen.cpp.

{
 return m_rtree.contains( aItem, true );
}

References EE_RTREE::contains(), and m_rtree.

Referenced by SCH_EDIT_FRAME::AddItemToScreenAndUndoList().

ClassOf()

bool SCH_SCREEN::ClassOf ( const EDA_ITEM *  aItem )

static

Definition at line 140 of file sch_screen.cpp.

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

References SCH_SCREEN_T, and EDA_ITEM::Type().

Clear()

void SCH_SCREEN::Clear

(

bool

aFree = true

)

Delete all draw items and clears the project settings.

Definition at line 228 of file sch_screen.cpp.

{
 if( aFree )
 {
 FreeDrawList();
 clearLibSymbols();
 }
 else
 {
 m_rtree.clear();
 }

 // Clear the project settings
 m_virtualPageNumber = m_pageCount = 1;

 m_titles.Clear();
}

References EE_RTREE::clear(), TITLE_BLOCK::Clear(), clearLibSymbols(), FreeDrawList(), BASE_SCREEN::m_pageCount, m_rtree, m_titles, and BASE_SCREEN::m_virtualPageNumber.

Referenced by Append(), SCH_EDIT_FRAME::doCloseWindow(), and SCH_EDITOR_CONTROL::Paste().

ClearAnnotation()

void SCH_SCREEN::ClearAnnotation

(

SCH_SHEET_PATH *

aSheetPath

)

Clear the annotation for the symbols in aSheetPath on the screen.

Parameters

[in]

aSheetPath

The sheet path of the symbol annotation to clear. If NULL then the entire hierarchy is cleared.

Definition at line 984 of file sch_screen.cpp.

{

 for( SCH_ITEM* item : Items().OfType( SCH_SYMBOL_T ) )
 {
 SCH_SYMBOL* symbol = static_cast<SCH_SYMBOL*>( item );

 symbol->ClearAnnotation( aSheetPath );
 }
}

References SCH_SYMBOL::ClearAnnotation(), Items(), and SCH_SYMBOL_T.

Referenced by SCH_SCREENS::ClearAnnotationOfNewSheetPaths(), and SCH_EDIT_TOOL::Properties().

ClearBrightened()

void EDA_ITEM::ClearBrightened ( )

inlineinherited

Definition at line 132 of file eda_item.h.

{ ClearFlags( BRIGHTENED ); }

References BRIGHTENED, and EDA_ITEM::ClearFlags().

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

ClearBusAliases()

void SCH_SCREEN::ClearBusAliases ( )

inline

Remove all bus alias definitions.

Definition at line 473 of file sch_screen.h.

 {
 m_aliases.clear();
 }

References m_aliases.

ClearDrawingState()

void SCH_SCREEN::ClearDrawingState

(

)

Clear the state flags of all the items in the screen.

Definition at line 893 of file sch_screen.cpp.

{
 for( SCH_ITEM* item : Items() )
 item->ClearTempFlags();
}

References Items().

Referenced by SCH_EDIT_FRAME::OpenProjectFiles(), and EE_SELECTION_TOOL::SelectConnection().

ClearEditFlags()

void EDA_ITEM::ClearEditFlags ( )

inlineinherited

Definition at line 171 of file eda_item.h.

 {
 ClearFlags( GetEditFlags() );
 }

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

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

ClearFlags()

void EDA_ITEM::ClearFlags ( EDA_ITEM_FLAGS  aMask = EDA_ITEM_ALL_FLAGS )

inlineinherited

Definition at line 153 of file eda_item.h.

{ m_flags &= ~aMask; }

References EDA_ITEM::m_flags.

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

clearLibSymbols()

void SCH_SCREEN::clearLibSymbols ( )

private

Definition at line 101 of file sch_screen.cpp.

{
 for( auto libSymbol : m_libSymbols )
 delete libSymbol.second;

 m_libSymbols.clear();
}

References m_libSymbols.

Referenced by Clear(), UpdateSymbolLinks(), and ~SCH_SCREEN().

ClearSelected()

void EDA_ITEM::ClearSelected ( )

inlineinherited

Definition at line 131 of file eda_item.h.

{ ClearFlags( SELECTED ); }

References EDA_ITEM::ClearFlags(), and SELECTED.

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

ClearTempFlags()

void EDA_ITEM::ClearTempFlags ( )

inlineinherited

Definition at line 165 of file eda_item.h.

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

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

Referenced by SCH_EDIT_FRAME::PutDataInPreviousState().

ClearViewPrivData()

void KIGFX::VIEW_ITEM::ClearViewPrivData ( )

inlineinherited

Definition at line 143 of file view_item.h.

 {
 m_viewPrivData = nullptr;
 }

References KIGFX::VIEW_ITEM::m_viewPrivData.

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

Clone()

EDA_ITEM * 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 FP_ZONE, ZONE, SCH_SYMBOL, PAD, FOOTPRINT, PCB_DIM_CENTER, PCB_DIM_LEADER, SCH_HIERLABEL, PCB_DIM_ORTHOGONAL, PCB_VIA, SCH_SHEET, PCB_DIM_ALIGNED, SCH_GLOBALLABEL, SCH_LABEL, PCB_ARC, SCH_TEXT, SCH_LINE, SCH_BUS_BUS_ENTRY, LIB_PIN, FP_TEXT, SCH_FIELD, SCH_SHEET_PIN, PCB_TRACK, SCH_BUS_WIRE_ENTRY, LIB_FIELD, FP_SHAPE, PCB_TEXT, SCH_BITMAP, PCB_SHAPE, PCB_GROUP, SCH_JUNCTION, SCH_NO_CONNECT, LIB_TEXT, SCH_MARKER, LIB_SHAPE, NETINFO_ITEM, PCB_TARGET, SCH_PIN, PCB_MARKER, and KIGFX::ORIGIN_VIEWITEM.

Definition at line 83 of file eda_item.cpp.

{
 wxCHECK_MSG( false, nullptr, wxT( "Clone not implemented in derived class " ) + GetClass() +
 wxT( ". Bad programmer!" ) );
}

References EDA_ITEM::GetClass().

Referenced by BOOST_AUTO_TEST_CASE(), DIALOG_DIMENSION_PROPERTIES::DIALOG_DIMENSION_PROPERTIES(), SYMBOL_EDITOR_DRAWING_TOOLS::DrawShape(), SYMBOL_EDITOR_EDIT_TOOL::Duplicate(), BOARD_ITEM::Duplicate(), SCH_ITEM::Duplicate(), PCB_DIMENSION_BASE::GetEffectiveShape(), LIB_SYMBOL::LIB_SYMBOL(), new_clone(), LIB_SYMBOL::operator=(), SYMBOL_EDITOR_EDIT_TOOL::Paste(), SCH_SEXPR_PLUGIN_CACHE::removeSymbol(), SCH_LEGACY_PLUGIN_CACHE::removeSymbol(), SCH_EDIT_FRAME::SaveCopyForRepeatItem(), PCB_BASE_EDIT_FRAME::SaveCopyInUndoList(), CLIPBOARD_IO::SaveSelection(), LIB_SYMBOL::SetConversion(), LIB_SYMBOL::SetUnitCount(), SCH_DRAWING_TOOLS::SingleClickPlace(), COMMIT::Stage(), SYMBOL_EDITOR_DRAWING_TOOLS::TwoClickPlace(), and SCH_DRAWING_TOOLS::TwoClickPlace().

CountConnectedItems()

size_t SCH_SCREEN::CountConnectedItems	(	const wxPoint &	aPos,
		bool	aTestJunctions
	)		const

Definition at line 970 of file sch_screen.cpp.

{
 size_t count = 0;

 for( const SCH_ITEM* item : Items().Overlapping( aPos ) )
 {
 if( ( item->Type() != SCH_JUNCTION_T || aTestJunctions ) && item->IsConnected( aPos ) )
 count++;
 }

 return count;
}

References Items(), and SCH_JUNCTION_T.

DecRefCount()

void SCH_SCREEN::DecRefCount

(

)

Definition at line 124 of file sch_screen.cpp.

{
 wxCHECK_RET( m_refCount != 0,
 wxT( "Screen reference count already zero. Bad programmer!" ) );
 m_refCount--;
}

References m_refCount.

Referenced by SCH_SHEET::SetScreen(), and SCH_SHEET::~SCH_SHEET().

DeleteItem()

void SCH_SCREEN::DeleteItem

(

SCH_ITEM *

aItem

)

Removes aItem from the linked list and deletes the object.

If aItem is a schematic sheet label, it is removed from the screen associated with the sheet that contains the label to be deleted.

Parameters

[in]

aItem

The schematic object to be deleted from the screen.

Definition at line 311 of file sch_screen.cpp.

{
 wxCHECK_RET( aItem, wxT( "Cannot delete invalid item from screen." ) );

 // Markers are not saved in the file, no need to flag as modified.
 // TODO: Maybe we should have a listing somewhere of items that aren't saved?
 if( aItem->Type() != SCH_MARKER_T )
 SetContentModified();

 Remove( aItem );

 if( aItem->Type() == SCH_SHEET_PIN_T )
 {
 // This structure is attached to a sheet, get the parent sheet object.
 SCH_SHEET_PIN* sheetPin = (SCH_SHEET_PIN*) aItem;
 SCH_SHEET* sheet = sheetPin->GetParent();
 wxCHECK_RET( sheet, wxT( "Sheet pin parent not properly set, bad programmer!" ) );
 sheet->RemovePin( sheetPin );
 return;
 }

 delete aItem;
}

References SCH_SHEET_PIN::GetParent(), Remove(), SCH_SHEET::RemovePin(), SCH_MARKER_T, SCH_SHEET_PIN_T, BASE_SCREEN::SetContentModified(), and EDA_ITEM::Type().

doIsJunction()

bool SCH_SCREEN::doIsJunction ( const wxPoint &  aPosition, bool  aBreakCrossings, bool *  aHasExplicitJunctionDot, bool *  aHasBusEntry  ) const

private

Definition at line 444 of file sch_screen.cpp.

{
 enum layers { WIRES = 0, BUSES };

 *aHasExplicitJunctionDot = false;
 *aHasBusEntry = false;

 bool breakLines[ 2 ] = { false };
 std::unordered_set<int> exitAngles[ 2 ];
 std::vector<const SCH_LINE*> midPointLines[ 2 ];

 // A pin at 90º still shouldn't match a line at 90º so just give pins unique numbers
 int uniqueAngle = 10000;

 for( const SCH_ITEM* item : Items().Overlapping( aPosition ) )
 {
 if( item->GetEditFlags() & STRUCT_DELETED )
 continue;

 switch( item->Type() )
 {
 case SCH_JUNCTION_T:
 if( item->HitTest( aPosition, -1 ) )
 *aHasExplicitJunctionDot = true;

 break;

 case SCH_LINE_T:
 {
 const SCH_LINE* line = static_cast<const SCH_LINE*>( item );
 int layer;

 if( line->GetStartPoint() == line->GetEndPoint() )
 break;
 else if( line->GetLayer() == LAYER_WIRE )
 layer = WIRES;
 else if( line->GetLayer() == LAYER_BUS )
 layer = BUSES;
 else
 break;

 if( line->IsConnected( aPosition ) )
 {
 breakLines[ layer ] = true;
 exitAngles[ layer ].insert( line->GetAngleFrom( aPosition ) );
 }
 else if( line->HitTest( aPosition, -1 ) )
 {
 if( aBreakCrossings )
 breakLines[ layer ] = true;

 // Defer any line midpoints until we know whether or not we're breaking them
 midPointLines[ layer ].push_back( line );
 }
 }
 break;

 case SCH_BUS_WIRE_ENTRY_T:
 if( item->IsConnected( aPosition ) )
 {
 breakLines[ BUSES ] = true;
 exitAngles[ BUSES ].insert( uniqueAngle++ );
 breakLines[ WIRES ] = true;
 exitAngles[ WIRES ].insert( uniqueAngle++ );
 *aHasBusEntry = true;
 }

 break;

 case SCH_SYMBOL_T:
 case SCH_SHEET_T:
 if( item->IsConnected( aPosition ) )
 {
 breakLines[ WIRES ] = true;
 exitAngles[ WIRES ].insert( uniqueAngle++ );
 }

 break;

 default:
 break;
 }
 }

 for( int layer : { WIRES, BUSES } )
 {
 if( breakLines[ layer ] )
 {
 for( const SCH_LINE* line : midPointLines[ layer ] )
 {
 exitAngles[ layer ].insert( line->GetAngleFrom( aPosition ) );
 exitAngles[ layer ].insert( line->GetReverseAngleFrom( aPosition ) );
 }
 }
 }

 return exitAngles[ WIRES ].size() >= 3 || exitAngles[ BUSES ].size() >= 3;
}

References SCH_LINE::GetAngleFrom(), SCH_LINE::GetEndPoint(), SCH_ITEM::GetLayer(), SCH_LINE::GetStartPoint(), SCH_LINE::HitTest(), SCH_ITEM::IsConnected(), Items(), LAYER_BUS, LAYER_WIRE, SCH_BUS_WIRE_ENTRY_T, SCH_JUNCTION_T, SCH_LINE_T, SCH_SHEET_T, SCH_SYMBOL_T, and STRUCT_DELETED.

Referenced by IsExplicitJunction(), IsExplicitJunctionAllowed(), IsExplicitJunctionNeeded(), and IsJunction().

EnsureAlternateReferencesExist()

void SCH_SCREEN::EnsureAlternateReferencesExist

(

)

For screens shared by many sheetpaths (complex hierarchies): to be able to clear or modify any reference related sharing this screen (i.e.

the list of symbols), an entry for each screen path must exist. This function creates missing entries, using as default reference the current reference field and unit number Note: m_clientSheetPathList must be up to date ( built by SCH_SCREENS::BuildClientSheetPathList() )

Definition at line 996 of file sch_screen.cpp.

{
 if( GetClientSheetPaths().size() <= 1 ) // No need for alternate reference
 return;

 for( SCH_ITEM* item : Items().OfType( SCH_SYMBOL_T ) )
 {
 SCH_SYMBOL* symbol = static_cast<SCH_SYMBOL*>( item );

 // Add (when not existing) all sheet path entries
 for( const SCH_SHEET_PATH& sheet : GetClientSheetPaths() )
 symbol->AddSheetPathReferenceEntryIfMissing( sheet.Path() );
 }
}

References SCH_SYMBOL::AddSheetPathReferenceEntryIfMissing(), GetClientSheetPaths(), Items(), and SCH_SYMBOL_T.

Referenced by SCH_SCREENS::ClearAnnotationOfNewSheetPaths().

FileExists()

bool SCH_SCREEN::FileExists ( ) const

inline

Definition at line 151 of file sch_screen.h.

{ return m_fileExists; }

References m_fileExists.

Referenced by SCH_EDIT_FRAME::UpdateTitle().

FreeDrawList()

void SCH_SCREEN::FreeDrawList

(

)

Free all the items from the schematic associated with the screen.

This does not delete any sub hierarchies.

Definition at line 247 of file sch_screen.cpp.

{
 // We don't know which order we will encounter dependent items (e.g. pins or fields), so
 // we store the items to be deleted until we've fully cleared the tree before deleting
 std::vector<SCH_ITEM*> delete_list;

 std::copy_if( m_rtree.begin(), m_rtree.end(), std::back_inserter( delete_list ),
 []( SCH_ITEM* aItem )
 {
 return ( aItem->Type() != SCH_SHEET_PIN_T && aItem->Type() != SCH_FIELD_T );
 } );

 m_rtree.clear();

 for( SCH_ITEM* item : delete_list )
 delete item;
}

References EE_RTREE::begin(), EE_RTREE::clear(), EE_RTREE::end(), m_rtree, SCH_FIELD_T, and SCH_SHEET_PIN_T.

Referenced by Clear(), and ~SCH_SCREEN().

Get() [1/3]

wxAny INSPECTABLE::Get ( PROPERTY_BASE *  aProperty )

inlineinherited

Definition at line 86 of file inspectable.h.

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

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

Referenced by BOOST_AUTO_TEST_CASE(), CLASS_D_DESC::CLASS_D_DESC(), PCB_EXPR_VAR_REF::GetValue(), and PAD_DESC::PAD_DESC().

Get() [2/3]

template<typename T >

T INSPECTABLE::Get ( PROPERTY_BASE *  aProperty )

inlineinherited

Definition at line 95 of file inspectable.h.

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

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

Get() [3/3]

template<typename T >

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

inlineinherited

Definition at line 104 of file inspectable.h.

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

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

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

 return ret;
 }

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

GetAuxOrigin()

const wxPoint& SCH_SCREEN::GetAuxOrigin ( ) const

inline

Definition at line 153 of file sch_screen.h.

{ return m_aux_origin; }

References m_aux_origin.

GetBoundingBox()

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

Definition at line 75 of file eda_item.cpp.

{
 // return a zero-sized box per default. derived classes should override
 // this
 return EDA_RECT( wxPoint( 0, 0 ), wxSize( 0, 0 ) );
}

Referenced by CADSTAR_SCH_ARCHIVE_LOADER::applyTextSettings(), CN_ITEM::BBox(), TEST_EE_ITEM_FIXTURE::CompareItems(), TEST_BOARD_ITEM_FIXTURE::CompareItems(), EE_RTREE::contains(), KIGFX::PCB_PAINTER::Draw(), PCB_BASE_FRAME::FocusOnItem(), LIB_ITEM::GetBoundingBox(), GetBoundingBoxes(), GERBVIEW_SELECTION::GetCenter(), BOARD_ITEM::GetCenter(), SCH_MOVE_TOOL::getConnectedDragItems(), EE_SELECTION_TOOL::GuessSelectionCandidates(), EE_RTREE::insert(), insideArea(), insideBackCourtyard(), insideCourtyard(), insideFrontCourtyard(), SCH_EDIT_TOOL::Mirror(), DRC_RTREE::QueryColliding(), EE_RTREE::remove(), DRC_TEST_PROVIDER_COPPER_CLEARANCE::testItemAgainstZones(), GERBVIEW_SELECTION::ViewBBox(), and EDA_ITEM::ViewBBox().

GetBus()

SCH_LINE* SCH_SCREEN::GetBus ( const wxPoint &  aPosition, int  aAccuracy = 0, SCH_LINE_TEST_T  aSearchType = ENTIRE_LENGTH_T  ) const

inline

Definition at line 429 of file sch_screen.h.

 {
 return GetLine( aPosition, aAccuracy, LAYER_BUS, aSearchType );
 }

References GetLine(), and LAYER_BUS.

Referenced by IsTerminalPoint(), and CONNECTION_GRAPH::updateItemConnectivity().

GetBusAliases()

std::unordered_set< std::shared_ptr<BUS_ALIAS> > SCH_SCREEN::GetBusAliases ( ) const

inline

Return a list of bus aliases defined in this screen.

Definition at line 481 of file sch_screen.h.

 {
 return m_aliases;
 }

References m_aliases.

Referenced by SCH_SEXPR_PLUGIN::Format(), and SCH_LEGACY_PLUGIN::Format().

GetClass()

virtual wxString SCH_SCREEN::GetClass ( ) const

inlineoverridevirtual

Return the class name.

Returns

wxString

Reimplemented from BASE_SCREEN.

Definition at line 124 of file sch_screen.h.

 {
 return wxT( "SCH_SCREEN" );
 }

GetClientSheetPaths()

std::vector<SCH_SHEET_PATH>& SCH_SCREEN::GetClientSheetPaths ( )

inline

Return the number of times this screen is used.

In the legacy file formats: if this screen is used only once (not a complex hierarchy) the reference field can be used to store the symbol reference. If this screen is used more than once (a complex hierarchy), then symbols must have a full alternate reference management via sheet paths.

In the new schematic file format, all instance data is stored in the root sheet even for simple hierarchies.

Returns

the sheet paths sharing this screen.

Definition at line 179 of file sch_screen.h.

 {
 return m_clientSheetPathList;
 }

References m_clientSheetPathList.

Referenced by SCH_SCREENS::BuildClientSheetPathList(), EnsureAlternateReferencesExist(), and SCH_EDIT_FRAME::SaveProject().

GetEditFlags()

EDA_ITEM_FLAGS EDA_ITEM::GetEditFlags ( ) const

inlineinherited

Definition at line 157 of file eda_item.h.

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

 return m_flags & mask;
 }

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

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

GetFileFormatVersionAtLoad()

int SCH_SCREEN::GetFileFormatVersionAtLoad ( ) const

inline

Definition at line 130 of file sch_screen.h.

{ return m_fileFormatVersionAtLoad; }

References m_fileFormatVersionAtLoad.

Referenced by SCH_EDIT_FRAME::OpenProjectFiles().

GetFileName()

const wxString& SCH_SCREEN::GetFileName ( void  ) const

inline

Definition at line 145 of file sch_screen.h.

{ return m_fileName; }

References m_fileName.

Referenced by SCH_EDIT_FRAME::canCloseWindow(), SCH_EDIT_FRAME::checkForNoFullyDefinedLibIds(), SCH_EDIT_FRAME::CheckSheetForRecursion(), SCH_EDIT_FRAME::CreateArchiveLibraryCacheFile(), KIGFX::SCH_VIEW::DisplaySheet(), SCH_EDIT_FRAME::doAutoSave(), SCHEMATIC::GetFileName(), DIALOG_PLOT_SCHEMATIC::getOutputPath(), SCH_LEGACY_PLUGIN::loadHeader(), NETLIST_EXPORTER_XML::makeDesignHeader(), SCH_SHEET_PATH::MakeFilePathRelativeToParentSheet(), DIALOG_SHEET_PROPERTIES::onSheetFilenameChanged(), SCH_EDITOR_CONTROL::Paste(), SCH_SHEET_PATH::PathHumanReadable(), DIALOG_PLOT_SCHEMATIC::plotOneSheetDXF(), DIALOG_PLOT_SCHEMATIC::plotOneSheetHpgl(), DIALOG_PLOT_SCHEMATIC::plotOneSheetPDF(), DIALOG_PLOT_SCHEMATIC::plotOneSheetPS(), DIALOG_PLOT_SCHEMATIC::plotOneSheetSVG(), SCH_EDITOR_CONTROL::Print(), SCH_PRINTOUT::PrintPage(), SCH_EDIT_FRAME::SaveProject(), SCH_EDIT_FRAME::SaveProjectSettings(), SCH_EDIT_FRAME::saveSchematicFile(), SCH_SHEET::SearchHierarchy(), DIALOG_SHEET_PROPERTIES::TransferDataFromWindow(), SCH_EDIT_FRAME::updateAutoSaveFile(), and SCH_EDIT_FRAME::UpdateTitle().

GetFlags()

EDA_ITEM_FLAGS EDA_ITEM::GetFlags ( ) const

inlineinherited

Definition at line 154 of file eda_item.h.

{ return m_flags; }

References EDA_ITEM::m_flags.

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

GetFocusPosition()

virtual const wxPoint EDA_ITEM::GetFocusPosition ( ) const

inlinevirtualinherited

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

Reimplemented in BOARD, PCB_TRACK, and PCB_SHAPE.

Definition at line 258 of file eda_item.h.

{ return GetPosition(); }

References EDA_ITEM::GetPosition().

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

GetHierarchicalItems()

void SCH_SCREEN::GetHierarchicalItems

(

std::vector< SCH_ITEM * > *

aItems

)

const

Add all schematic sheet and symbol objects in the screen to aItems.

Parameters

[out]

aItems

Hierarchical item list to fill.

Definition at line 1012 of file sch_screen.cpp.

{
 static KICAD_T hierarchicalTypes[] = { SCH_SYMBOL_T, SCH_SHEET_T, SCH_GLOBAL_LABEL_T, EOT };

 for( SCH_ITEM* item : Items() )
 {
 if( item->IsType( hierarchicalTypes ) )
 aItems->push_back( item );
 }
}

References EOT, Items(), SCH_GLOBAL_LABEL_T, SCH_SHEET_T, and SCH_SYMBOL_T.

GetItem()

SCH_ITEM * SCH_SCREEN::GetItem	(	const wxPoint &	aPosition,
		int	aAccuracy = 0,
		KICAD_T	aType = SCH_LOCATE_ANY_T
	)		const

Check aPosition within a distance of aAccuracy for items of type aFilter.

Parameters

[in]	aPosition	Position in drawing units.
	aAccuracy	The maximum distance within Position to check for an item.
	aType	The type of item to find.

Returns

The item found that meets the search criteria or NULL if none found.

Definition at line 342 of file sch_screen.cpp.

{
 EDA_RECT bbox;
 bbox.SetOrigin( aPosition );
 bbox.Inflate( aAccuracy );

 for( SCH_ITEM* item : Items().Overlapping( aType, bbox ) )
 {
 if( item->HitTest( aPosition, aAccuracy ) )
 return item;
 }

 return nullptr;
}

References EDA_RECT::Inflate(), Items(), and EDA_RECT::SetOrigin().

Referenced by SCH_EDIT_TOOL::DoDelete(), IsTerminalPoint(), and SCH_DRAWING_TOOLS::SingleClickPlace().

GetLabel()

SCH_TEXT * SCH_SCREEN::GetLabel	(	const wxPoint &	aPosition,
		int	aAccuracy = 0
	)		const

Return a label item located at aPosition.

Parameters

[in]	aPosition	The wxPoint to test for label items.
	aAccuracy	Amount to inflate the item hit test bounding box.

Returns

The SCH_TEXT* of the label item found at aPosition or NULL if item not found.

Definition at line 1107 of file sch_screen.cpp.

{
 for( SCH_ITEM* item : Items().Overlapping( aPosition, aAccuracy ) )
 {
 switch( item->Type() )
 {
 case SCH_LABEL_T:
 case SCH_GLOBAL_LABEL_T:
 case SCH_HIER_LABEL_T:
 if( item->HitTest( aPosition, aAccuracy ) )
 return static_cast<SCH_TEXT*>( item );

 break;

 default:
 ;
 }
 }

 return nullptr;
}

References Items(), SCH_GLOBAL_LABEL_T, SCH_HIER_LABEL_T, and SCH_LABEL_T.

Referenced by IsTerminalPoint().

GetLibSymbols() [1/2]

std::map<wxString, LIB_SYMBOL*>& SCH_SCREEN::GetLibSymbols ( )

inline

Fetch a list of unique LIB_SYMBOL object pointers required to properly render each SCH_SYMBOL in this schematic.

Returns

The list of unique LIB_SYMBOL object pointers.

Definition at line 451 of file sch_screen.h.

{ return m_libSymbols; }

References m_libSymbols.

Referenced by NETLIST_EXPORTER_BASE::findNextSymbol(), SCH_SEXPR_PLUGIN::Format(), and SCH_EDITOR_CONTROL::Paste().

GetLibSymbols() [2/2]

const std::map<wxString, LIB_SYMBOL*>& SCH_SCREEN::GetLibSymbols ( ) const

inline

Definition at line 452 of file sch_screen.h.

{ return m_libSymbols; }

References m_libSymbols.

GetLine()

SCH_LINE * SCH_SCREEN::GetLine	(	const wxPoint &	aPosition,
		int	aAccuracy = 0,
		int	aLayer = LAYER_NOTES,
		SCH_LINE_TEST_T	aSearchType = ENTIRE_LENGTH_T
	)		const

Return a line item located at aPosition.

Parameters

[in]	aPosition	The wxPoint to test for a line item.
	aAccuracy	Amount to inflate the item hit test bounding box.
	aLayer	The layer the line is drawn upon.
	aSearchType	Additional line test criteria.

Returns

The SCH_LINE* of the wire item found at aPosition or NULL if item not found.

Definition at line 1070 of file sch_screen.cpp.

{
 // an accuracy of 0 had problems with rounding errors; use at least 1
 aAccuracy = std::max( aAccuracy, 1 );

 for( SCH_ITEM* item : Items().Overlapping( aPosition, aAccuracy ) )
 {
 if( item->Type() != SCH_LINE_T )
 continue;

 if( item->GetLayer() != aLayer )
 continue;

 if( !item->HitTest( aPosition, aAccuracy ) )
 continue;

 switch( aSearchType )
 {
 case ENTIRE_LENGTH_T:
 return (SCH_LINE*) item;

 case EXCLUDE_END_POINTS_T:
 if( !( (SCH_LINE*) item )->IsEndPoint( aPosition ) )
 return (SCH_LINE*) item;
 break;

 case END_POINTS_ONLY_T:
 if( ( (SCH_LINE*) item )->IsEndPoint( aPosition ) )
 return (SCH_LINE*) item;
 }
 }

 return nullptr;
}

References END_POINTS_ONLY_T, ENTIRE_LENGTH_T, EXCLUDE_END_POINTS_T, Items(), and SCH_LINE_T.

Referenced by GetBus(), GetWire(), and IsTerminalPoint().

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

Definition at line 274 of file eda_item.cpp.

{
 return BITMAPS::dummy_item;
}

References dummy_item.

Referenced by GERBVIEW_SELECTION_TOOL::disambiguationMenu(), PL_SELECTION_TOOL::doSelectionMenu(), EE_SELECTION_TOOL::doSelectionMenu(), and PCB_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

aList

is the list to populate.

Reimplemented in BOARD, PAD, PCB_DIM_LEADER, FOOTPRINT, PCB_DIM_ALIGNED, PCB_VIA, SCH_SYMBOL, SCH_TEXT, SCH_LINE, PCB_DIMENSION_BASE, PCB_GROUP, GERBER_DRAW_ITEM, SCH_FIELD, LIB_ITEM, FP_TEXT, PCB_TRACK, LIB_PIN, SCH_SHEET, NETINFO_ITEM, FP_SHAPE, SCH_BITMAP, LIB_FIELD, ZONE, SCH_BUS_ENTRY_BASE, LIB_TEXT, DS_DRAW_ITEM_BASE, PCB_SHAPE, PCB_TARGET, PCB_TEXT, SCH_MARKER, PCB_MARKER, LIB_SHAPE, and SCH_PIN.

Definition at line 213 of file eda_item.h.

 {
 }

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

GetPageCount()

int BASE_SCREEN::GetPageCount ( ) const

inlineinherited

Definition at line 72 of file base_screen.h.

{ return m_pageCount; }

References BASE_SCREEN::m_pageCount.

Referenced by KIGFX::SCH_VIEW::DisplaySheet(), SCH_LEGACY_PLUGIN::Format(), DIALOG_EESCHEMA_PAGE_SETTINGS::onTransferDataToWindow(), DIALOG_PLOT_SCHEMATIC::plotOneSheetDXF(), DIALOG_PLOT_SCHEMATIC::plotOneSheetHpgl(), DIALOG_PLOT_SCHEMATIC::plotOneSheetPDF(), DIALOG_PLOT_SCHEMATIC::plotOneSheetPS(), DIALOG_PLOT_SCHEMATIC::plotOneSheetSVG(), EDA_DRAW_FRAME::PrintDrawingSheet(), PCB_EDIT_FRAME::SetPageSettings(), and DIALOG_PAGES_SETTINGS::UpdateDrawingSheetExample().

GetPageNumber()

const wxString & BASE_SCREEN::GetPageNumber ( ) const

inherited

Definition at line 71 of file base_screen.cpp.

{
 static wxString pageNumber;

 if( m_pageNumber.IsEmpty() )
 pageNumber.Printf( "%d", m_virtualPageNumber );
 else
 pageNumber = m_pageNumber;

 return pageNumber;
}

References BASE_SCREEN::m_pageNumber, and BASE_SCREEN::m_virtualPageNumber.

Referenced by KIGFX::SCH_VIEW::DisplaySheet(), DIALOG_PLOT_SCHEMATIC::plotOneSheetDXF(), DIALOG_PLOT_SCHEMATIC::plotOneSheetHpgl(), DIALOG_PLOT_SCHEMATIC::plotOneSheetPDF(), DIALOG_PLOT_SCHEMATIC::plotOneSheetPS(), DIALOG_PLOT_SCHEMATIC::plotOneSheetSVG(), EDA_DRAW_FRAME::PrintDrawingSheet(), PCB_EDIT_FRAME::SetPageSettings(), and DIALOG_PAGES_SETTINGS::UpdateDrawingSheetExample().

GetPageSettings()

const PAGE_INFO& SCH_SCREEN::GetPageSettings ( ) const

inline

Definition at line 132 of file sch_screen.h.

{ return m_paper; }

References m_paper.

Referenced by DIALOG_PLOT_SCHEMATIC::createHPGLFiles(), DIALOG_PLOT_SCHEMATIC::createPSFiles(), KIGFX::SCH_VIEW::DisplaySheet(), SYMBOL_EDITOR_CONTROL::ExportSymbolAsSVG(), SCH_SEXPR_PLUGIN::Format(), SCH_LEGACY_PLUGIN::Format(), SCH_EDIT_FRAME::GetDocumentExtents(), SCH_BASE_FRAME::GetPageSettings(), SCH_BASE_FRAME::GetPageSizeIU(), CADSTAR_SCH_ARCHIVE_LOADER::Load(), SCH_EAGLE_PLUGIN::loadSchematic(), SCH_EAGLE_PLUGIN::loadSheet(), DIALOG_PLOT_SCHEMATIC::plotOneSheetDXF(), DIALOG_PLOT_SCHEMATIC::plotOneSheetSVG(), SCH_PRINTOUT::PrintPage(), SYMBOL_EDIT_FRAME::PrintPage(), KIGFX::SCH_VIEW::ResizeSheetWorkingArea(), DIALOG_PLOT_SCHEMATIC::setupPlotPagePDF(), SYMBOL_EDIT_FRAME::SVGPlotSymbol(), and DIALOG_PRINT_USING_PRINTER::TransferDataToWindow().

GetParent()

EDA_ITEM* EDA_ITEM::GetParent ( void  ) const

inlineinherited

Definition at line 114 of file eda_item.h.

{ return m_parent; }

References EDA_ITEM::m_parent.

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

GetPin()

LIB_PIN * SCH_SCREEN::GetPin	(	const wxPoint &	aPosition,
		SCH_SYMBOL **	aSymbol = nullptr,
		bool	aEndPointOnly = false
	)		const

Test the screen for a symbol pin item at aPosition.

Parameters

[in]	aPosition	Position to test.
[out]	aSymbol	The symbol if a pin was found, otherwise NULL.
	aEndPointOnly	Set to true to test if aPosition is the connection point of the pin.

Returns

The pin item if found, otherwise NULL.

Definition at line 900 of file sch_screen.cpp.

{
 SCH_SYMBOL* candidate = nullptr;
 LIB_PIN* pin = nullptr;

 for( SCH_ITEM* item : Items().Overlapping( SCH_SYMBOL_T, aPosition ) )
 {
 candidate = static_cast<SCH_SYMBOL*>( item );

 if( aEndPointOnly )
 {
 pin = nullptr;

 if( !candidate->GetLibSymbolRef() )
 continue;

 for( pin = candidate->GetLibSymbolRef()->GetNextPin(); pin;
 pin = candidate->GetLibSymbolRef()->GetNextPin( pin ) )
 {
 // Skip items not used for this part.
 if( candidate->GetUnit() && pin->GetUnit() &&
 ( pin->GetUnit() != candidate->GetUnit() ) )
 continue;

 if( candidate->GetConvert() && pin->GetConvert() &&
 ( pin->GetConvert() != candidate->GetConvert() ) )
 continue;

 if( candidate->GetPinPhysicalPosition( pin ) == aPosition )
 break;
 }

 if( pin )
 break;
 }
 else
 {
 pin = (LIB_PIN*) candidate->GetDrawItem( aPosition, LIB_PIN_T );

 if( pin )
 break;
 }
 }

 if( pin && aSymbol )
 *aSymbol = candidate;

 return pin;
}

References SCH_SYMBOL::GetConvert(), SCH_SYMBOL::GetDrawItem(), SCH_SYMBOL::GetLibSymbolRef(), SCH_SYMBOL::GetPinPhysicalPosition(), SCH_SYMBOL::GetUnit(), Items(), LIB_PIN_T, pin, and SCH_SYMBOL_T.

Referenced by IsTerminalPoint(), and MarkConnections().

GetPosition()

virtual wxPoint EDA_ITEM::GetPosition ( ) const

inlinevirtualinherited

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

Definition at line 251 of file eda_item.h.

{ return wxPoint(); }

Referenced by BOOST_AUTO_TEST_CASE(), TEST_EE_ITEM_FIXTURE::CompareItems(), TEST_BOARD_ITEM_FIXTURE::CompareItems(), EE_GRID_HELPER::computeAnchors(), PCB_GRID_HELPER::computeAnchors(), SCH_EDIT_FRAME::DeleteJunction(), KIGFX::PCB_PAINTER::draw(), CONNECTION_GRAPH::ercCheckBusToBusConflicts(), CONNECTION_GRAPH::ercCheckBusToNetConflicts(), CONNECTION_GRAPH::ercCheckMultipleDrivers(), CONNECTION_GRAPH::ercCheckNoConnects(), PCB_SELECTION_TOOL::FindItem(), GERBVIEW_SELECTION::GetCenter(), EDA_ITEM::GetFocusPosition(), getMinDist(), SCH_FIELD::GetParentPosition(), GetSheets(), PCB_SELECTION::GetTopLeftItem(), EE_SELECTION::GetTopLeftItem(), BOARD_ITEM::GetX(), BOARD_ITEM::GetY(), SYMBOL_EDITOR_MOVE_TOOL::Main(), SCH_MOVE_TOOL::Main(), EDIT_POINTS_FACTORY::Make(), SYMBOL_EDITOR_EDIT_TOOL::Mirror(), SCH_EDIT_TOOL::Mirror(), EDIT_TOOL::MoveExact(), SCH_EDITOR_CONTROL::nextMatch(), BOARD::cmp_items::operator()(), SCH_ITEM::operator<(), PL_EDIT_TOOL::Paste(), SCH_EDITOR_CONTROL::Paste(), PCB_CONTROL::placeBoardItems(), POSITION_RELATIVE_TOOL::PositionRelative(), BACK_ANNOTATE::processNetNameChange(), PCB_BASE_EDIT_FRAME::PutDataInPreviousState(), SCH_EDIT_TOOL::RepeatDrawItem(), SYMBOL_EDITOR_EDIT_TOOL::Rotate(), SCH_EDIT_TOOL::Rotate(), PCB_SELECTION_TOOL::selectConnectedTracks(), RC_ITEM::ShowReport(), TransformItem(), DIALOG_POSITION_RELATIVE::UpdateAnchor(), PL_EDIT_TOOL::updateModificationPoint(), and EE_POINT_EDITOR::updatePoints().

GetRefCount()

int SCH_SCREEN::GetRefCount ( ) const

inline

Definition at line 162 of file sch_screen.h.

{ return m_refCount; }

References m_refCount.

Referenced by SCH_SHEET::GetScreenCount(), SCH_SHEET::SetScreen(), and SCH_SHEET::~SCH_SHEET().

GetSelectMenuText()

wxString EDA_ITEM::GetSelectMenuText ( EDA_UNITS  aUnits ) const

virtualinherited

Return the text to display to be used in the selection clarification context menu when multiple items are found at the current cursor position.

The default version of this function raises an assertion in the debug mode and returns a string to indicate that it was not overridden to provide the object specific text.

Returns

The menu text string.

Reimplemented in ZONE, SCH_SYMBOL, PAD, FOOTPRINT, BOARD, SCH_HIERLABEL, SCH_GLOBALLABEL, PCB_VIA, SCH_SHEET, DS_DRAW_ITEM_BITMAP, DELETED_BOARD_ITEM, DS_DRAW_ITEM_TEXT, SCH_LABEL, DS_DRAW_ITEM_PAGE, GERBER_DRAW_ITEM, PCB_DIMENSION_BASE, SCH_TEXT, DS_DRAW_ITEM_RECT, SCH_BUS_BUS_ENTRY, SCH_LINE, LIB_PIN, FP_TEXT, PCB_TRACK, SCH_FIELD, SCH_SHEET_PIN, PCB_GROUP, DS_DRAW_ITEM_POLYPOLYGONS, SCH_BUS_WIRE_ENTRY, LIB_FIELD, FP_SHAPE, DS_DRAW_ITEM_LINE, PCB_TEXT, PCB_SHAPE, SCH_BITMAP, LIB_TEXT, LIB_SHAPE, SCH_JUNCTION, PCB_MARKER, SCH_NO_CONNECT, SCH_MARKER, PCB_TARGET, SCH_PIN, and DELETED_SHEET_ITEM.

Definition at line 109 of file eda_item.cpp.

{
 wxFAIL_MSG( wxT( "GetSelectMenuText() was not overridden for schematic item type " ) +
 GetClass() );

 return wxString( wxT( "Undefined menu text for " ) + GetClass() );
}

References EDA_ITEM::GetClass().

Referenced by CONNECTION_GRAPH::buildConnectionGraph(), GERBVIEW_SELECTION_TOOL::disambiguationMenu(), DIALOG_GROUP_PROPERTIES::DoAddMember(), PL_SELECTION_TOOL::doSelectionMenu(), EE_SELECTION_TOOL::doSelectionMenu(), PCB_SELECTION_TOOL::doSelectionMenu(), DRC_ENGINE::EvalRules(), BOARD_INSPECTION_TOOL::getItemDescription(), PCB_MARKER::GetMsgPanelInfo(), RC_TREE_MODEL::GetValue(), RC_ITEM::ShowReport(), and DIALOG_POSITION_RELATIVE::UpdateAnchor().

GetSheetInstances()

const std::vector<SCH_SHEET_INSTANCE>& SCH_SCREEN::GetSheetInstances ( ) const

inline

Definition at line 491 of file sch_screen.h.

 {
 return m_sheetInstances;
 }

References m_sheetInstances.

Referenced by TEST_SCH_SHEET_LIST_FIXTURE::loadSchematic(), and SCH_EDITOR_CONTROL::setClipboardInstances().

GetSheetPin()

SCH_SHEET_PIN * SCH_SCREEN::GetSheetPin

(

const wxPoint &

aPosition

)

const

Test the screen if aPosition is a sheet label object.

Parameters

[in]

aPosition

The position to test.

Returns

The sheet label object if found otherwise NULL.

Definition at line 952 of file sch_screen.cpp.

{
 SCH_SHEET_PIN* sheetPin = nullptr;

 for( SCH_ITEM* item : Items().Overlapping( SCH_SHEET_T, aPosition ) )
 {
 SCH_SHEET* sheet = static_cast<SCH_SHEET*>( item );

 sheetPin = sheet->GetPin( aPosition );

 if( sheetPin )
 break;
 }

 return sheetPin;
}

References SCH_SHEET::GetPin(), Items(), and SCH_SHEET_T.

Referenced by IsTerminalPoint().

GetSheets()

void SCH_SCREEN::GetSheets

(

std::vector< SCH_ITEM * > *

aItems

)

const

Similar to Items().OfType( SCH_SHEET_T ), but return the sheets in a deterministic order (L-R, T-B) for sheet numbering.

Definition at line 1024 of file sch_screen.cpp.

{
 for( SCH_ITEM* item : Items().OfType( SCH_SHEET_T ) )
 aItems->push_back( item );

 std::sort( aItems->begin(), aItems->end(),
 []( EDA_ITEM* a, EDA_ITEM* b ) -> bool
 {
 if( a->GetPosition().x == b->GetPosition().x )
 {
 // Ensure deterministic sort
 if( a->GetPosition().y == b->GetPosition().y )
 return a->m_Uuid < b->m_Uuid;

 return a->GetPosition().y < b->GetPosition().y;
 }
 else
 return a->GetPosition().x < b->GetPosition().x;
 } );
}

References EDA_ITEM::GetPosition(), Items(), EDA_ITEM::m_Uuid, and SCH_SHEET_T.

Referenced by HIERARCHY_NAVIG_DLG::buildHierarchyTree(), and SCH_SHEET_LIST::BuildSheetList().

GetState()

int EDA_ITEM::GetState ( EDA_ITEM_FLAGS  type ) const

inlineinherited

Definition at line 136 of file eda_item.h.

 {
 return m_status & type;
 }

References EDA_ITEM::m_status.

Referenced by BOARD_ITEM::IsLocked().

GetStatus()

EDA_ITEM_FLAGS EDA_ITEM::GetStatus ( ) const

inlineinherited

Definition at line 149 of file eda_item.h.

{ return m_status; }

References EDA_ITEM::m_status.

GetSymbolInstances()

const std::vector<SYMBOL_INSTANCE_REFERENCE>& SCH_SCREEN::GetSymbolInstances ( ) const

inline

Definition at line 486 of file sch_screen.h.

 {
 return m_symbolInstances;
 }

References m_symbolInstances.

Referenced by TEST_SCH_SHEET_LIST_FIXTURE::loadSchematic(), TEST_NETLISTS_FIXTURE::loadSchematic(), and SCH_EDITOR_CONTROL::setClipboardInstances().

GetTitleBlock()

const TITLE_BLOCK& SCH_SCREEN::GetTitleBlock ( ) const

inline

Definition at line 156 of file sch_screen.h.

{ return m_titles; }

References m_titles.

Referenced by KIGFX::SCH_VIEW::DisplaySheet(), SCH_SEXPR_PLUGIN::Format(), SCH_LEGACY_PLUGIN::Format(), SCH_SHEET::GetContextualTextVars(), SCH_BASE_FRAME::GetTitleBlock(), NETLIST_EXPORTER_XML::makeDesignHeader(), SCHEMATIC::ResolveTextVar(), and SCH_SHEET::ResolveTextVar().

GetUuid()

const KIID& SCH_SCREEN::GetUuid ( ) const

inline

Definition at line 496 of file sch_screen.h.

{ return m_uuid; }

References m_uuid.

Referenced by SCH_EDIT_FRAME::SaveProject().

GetVirtualPageNumber()

int BASE_SCREEN::GetVirtualPageNumber ( ) const

inlineinherited

Definition at line 75 of file base_screen.h.

{ return m_virtualPageNumber; }

References BASE_SCREEN::m_virtualPageNumber.

Referenced by KIGFX::SCH_VIEW::DisplaySheet(), SCH_LEGACY_PLUGIN::Format(), DIALOG_EESCHEMA_PAGE_SETTINGS::onTransferDataToWindow(), DIALOG_PLOT_SCHEMATIC::plotOneSheetDXF(), DIALOG_PLOT_SCHEMATIC::plotOneSheetHpgl(), DIALOG_PLOT_SCHEMATIC::plotOneSheetPDF(), DIALOG_PLOT_SCHEMATIC::plotOneSheetPS(), DIALOG_PLOT_SCHEMATIC::plotOneSheetSVG(), EDA_DRAW_FRAME::PrintDrawingSheet(), and DIALOG_PAGES_SETTINGS::UpdateDrawingSheetExample().

GetWire()

SCH_LINE* SCH_SCREEN::GetWire ( const wxPoint &  aPosition, int  aAccuracy = 0, SCH_LINE_TEST_T  aSearchType = ENTIRE_LENGTH_T  ) const

inline

Definition at line 423 of file sch_screen.h.

 {
 return GetLine( aPosition, aAccuracy, LAYER_WIRE, aSearchType );
 }

References GetLine(), and LAYER_WIRE.

Referenced by IsTerminalPoint().

HasFlag()

bool EDA_ITEM::HasFlag ( EDA_ITEM_FLAGS  aFlag ) const

inlineinherited

Definition at line 155 of file eda_item.h.

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

References EDA_ITEM::m_flags.

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

HasItems()

bool SCH_SCREEN::HasItems

(

KICAD_T

aItemType

)

const

Definition at line 132 of file sch_screen.cpp.

{
 EE_RTREE::EE_TYPE sheets = m_rtree.OfType( aItemType );

 return sheets.begin() != sheets.end();
}

References EE_RTREE::EE_TYPE::begin(), EE_RTREE::EE_TYPE::end(), m_rtree, and EE_RTREE::OfType().

Referenced by HasSheets().

HasSheets()

bool SCH_SCREEN::HasSheets ( ) const

inline

Definition at line 120 of file sch_screen.h.

{ return HasItems( SCH_SHEET_T ); }

References HasItems(), and SCH_SHEET_T.

HitTest() [1/2]

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

inlinevirtualinherited

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

Parameters

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

Returns

True if aPosition is within the item bounding box.

Reimplemented in SCH_SYMBOL, PAD, FOOTPRINT, PCB_VIA, SCH_GLOBALLABEL, SCH_SHEET, DS_DRAW_ITEM_BITMAP, ZONE, DS_DRAW_ITEM_TEXT, PCB_ARC, DS_DRAW_ITEM_PAGE, SCH_TEXT, SCH_LINE, PCB_DIMENSION_BASE, DS_DRAW_ITEM_RECT, GERBER_DRAW_ITEM, SCH_FIELD, SCH_SHEET_PIN, FP_TEXT, PCB_TRACK, DS_DRAW_ITEM_POLYPOLYGONS, LIB_PIN, LIB_ITEM, PCB_GROUP, DS_DRAW_ITEM_LINE, SCH_BITMAP, LIB_FIELD, SCH_JUNCTION, SCH_BUS_ENTRY_BASE, SCH_NO_CONNECT, SCH_MARKER, PCB_SHAPE, PCB_TEXT, DS_DRAW_ITEM_BASE, SCH_PIN, PCB_TARGET, PCB_MARKER, LIB_TEXT, RATSNEST_VIEW_ITEM, and LIB_SHAPE.

Definition at line 224 of file eda_item.h.

 {
 return false; // derived classes should override this function
 }

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

HitTest() [2/2]

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

inlinevirtualinherited

Test if aRect intersects this item.

Parameters

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

Returns

True if aRect contains or intersects the item bounding box.

Reimplemented in SCH_SYMBOL, PAD, ZONE, FOOTPRINT, PCB_VIA, SCH_GLOBALLABEL, SCH_SHEET, DS_DRAW_ITEM_BITMAP, DS_DRAW_ITEM_TEXT, PCB_ARC, SCH_TEXT, SCH_LINE, PCB_DIMENSION_BASE, DS_DRAW_ITEM_RECT, GERBER_DRAW_ITEM, SCH_FIELD, FP_TEXT, PCB_TRACK, DS_DRAW_ITEM_POLYPOLYGONS, LIB_ITEM, LIB_PIN, PCB_GROUP, SCH_BITMAP, SCH_JUNCTION, SCH_BUS_ENTRY_BASE, PCB_TEXT, PCB_SHAPE, SCH_NO_CONNECT, DS_DRAW_ITEM_BASE, PCB_TARGET, LIB_TEXT, and LIB_SHAPE.

Definition at line 237 of file eda_item.h.

 {
 return false; // derived classes should override this function
 }

IncRefCount()

void SCH_SCREEN::IncRefCount

(

)

Definition at line 118 of file sch_screen.cpp.

{
 m_refCount++;
}

References m_refCount.

Referenced by SCH_SHEET::SCH_SHEET(), and SCH_SHEET::SetScreen().

InitDataPoints()

void BASE_SCREEN::InitDataPoints ( const wxSize &  aPageSizeInternalUnits )

inherited

Definition at line 46 of file base_screen.cpp.

{
 if( m_Center )
 {
 m_DrawOrg.x = -aPageSizeIU.x / 2;
 m_DrawOrg.y = -aPageSizeIU.y / 2;
 }
 else
 {
 m_DrawOrg.x = 0;
 m_DrawOrg.y = 0;
 }

 m_LocalOrigin = { 0, 0 };
}

References BASE_SCREEN::m_Center, BASE_SCREEN::m_DrawOrg, and BASE_SCREEN::m_LocalOrigin.

Referenced by BASE_SCREEN::BASE_SCREEN(), FOOTPRINT_EDIT_FRAME::Clear_Pcb(), PCB_EDIT_FRAME::Clear_Pcb(), SCH_SCREEN(), PL_EDITOR_FRAME::SetPageSettings(), PCB_BASE_FRAME::SetPageSettings(), and GERBVIEW_FRAME::SetPageSettings().

IsBrightened()

bool EDA_ITEM::IsBrightened ( ) const

inlineinherited

Definition at line 125 of file eda_item.h.

{ return m_flags & BRIGHTENED; }

References BRIGHTENED, and EDA_ITEM::m_flags.

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

IsContentModified()

bool BASE_SCREEN::IsContentModified ( ) const

inlineinherited

Definition at line 60 of file base_screen.h.

{ return m_flagModified; }

References BASE_SCREEN::m_flagModified.

Referenced by SCH_EDIT_FRAME::doAutoSave(), PCB_EDIT_FRAME::ExportSpecctraFile(), FP_TREE_SYNCHRONIZING_ADAPTER::GetAttr(), FP_TREE_SYNCHRONIZING_ADAPTER::GetValue(), FOOTPRINT_EDIT_FRAME::IsContentModified(), PL_EDITOR_FRAME::IsContentModified(), SCH_SHEET_LIST::IsModified(), and SCH_EDIT_FRAME::updateAutoSaveFile().

IsDragging()

bool EDA_ITEM::IsDragging ( ) const

inlineinherited

Definition at line 120 of file eda_item.h.

{ return m_flags & IS_DRAGGING; }

References IS_DRAGGING, and EDA_ITEM::m_flags.

Referenced by DIALOG_SYMBOL_PROPERTIES::DIALOG_SYMBOL_PROPERTIES().

IsEmpty()

bool SCH_SCREEN::IsEmpty ( ) const

inline

Definition at line 113 of file sch_screen.h.

 {
 return m_rtree.empty();
 }

References EE_RTREE::empty(), and m_rtree.

IsEntered()

bool EDA_ITEM::IsEntered ( ) const

inlineinherited

Definition at line 123 of file eda_item.h.

{ return m_flags & ENTERED; }

References ENTERED, and EDA_ITEM::m_flags.

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

IsExplicitJunction()

bool SCH_SCREEN::IsExplicitJunction

(

const wxPoint &

aPosition

)

const

Indicates that a junction dot is necessary at the given location.

See IsJunctionNeeded for more info.

Definition at line 413 of file sch_screen.cpp.

{
 bool hasExplicitJunction;
 bool hasBusEntry;
 bool isJunction = doIsJunction( aPosition, false, &hasExplicitJunction, &hasBusEntry );

 return isJunction && !hasBusEntry;
}

References doIsJunction().

Referenced by SCH_EDIT_TOOL::DoDelete(), and SCH_EDIT_FRAME::SchematicCleanUp().

IsExplicitJunctionAllowed()

bool SCH_SCREEN::IsExplicitJunctionAllowed

(

const wxPoint &

aPosition

)

const

Indicates that a juction dot may be placed at the given location.

See IsJunctionNeeded for more info.

Definition at line 433 of file sch_screen.cpp.

{
 bool hasExplicitJunction;
 bool hasBusEntry;
 bool isJunction = doIsJunction( aPosition, true, &hasExplicitJunction, &hasBusEntry );

 return isJunction && !hasBusEntry;
}

References doIsJunction().

Referenced by SCH_DRAWING_TOOLS::SingleClickPlace().

IsExplicitJunctionNeeded()

bool SCH_SCREEN::IsExplicitJunctionNeeded

(

const wxPoint &

aPosition

)

const

Indicates that a junction dot is necessary at the given location, and does not yet exist.

See IsJunctionNeeded for more info.

Definition at line 423 of file sch_screen.cpp.

{
 bool hasExplicitJunction;
 bool hasBusEntry;
 bool isJunction = doIsJunction( aPosition, false, &hasExplicitJunction, &hasBusEntry );

 return isJunction && !hasBusEntry && !hasExplicitJunction;
}

References doIsJunction().

Referenced by SCH_EDIT_FRAME::AddItemToScreenAndUndoList(), SCH_LINE_WIRE_BUS_TOOL::AddJunctionsIfNeeded(), SCH_EDIT_TOOL::BreakWire(), SCH_LINE_WIRE_BUS_TOOL::finishSegments(), and SCH_MOVE_TOOL::Main().

IsForceVisible()

bool EDA_ITEM::IsForceVisible ( ) const

inlineinherited

Definition at line 205 of file eda_item.h.

{ return m_forceVisible; }

References EDA_ITEM::m_forceVisible.

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

IsJunction()

bool SCH_SCREEN::IsJunction

(

const wxPoint &

aPosition

)

const

Test if a junction is required for the items at aPosition on the screen.

Note that this coule be either an implied junction (bus entry) or an explicit junction (dot).

A junction is required at aPosition if one of the following criteria is satisfied:

• One wire midpoint and one or more wire endpoints.
• Three or more wire endpoints.
• One wire midpoint and a symbol pin.
• Two or more wire endpoints and a symbol pin.
• One bus midpoint or endpoint and a bus entry.

Parameters

[in]

aPosition

The position to test.

Returns

True if a junction is required at aPosition.

Definition at line 403 of file sch_screen.cpp.

{
 bool hasExplicitJunction;
 bool hasBusEntry;
 bool isJunction = doIsJunction( aPosition, false, &hasExplicitJunction, &hasBusEntry );

 return isJunction;
}

References doIsJunction().

Referenced by SCH_LINE::MergeOverlap().

IsModified()

bool EDA_ITEM::IsModified ( ) const

inlineinherited

Definition at line 117 of file eda_item.h.

{ return m_flags & IS_CHANGED; }

References IS_CHANGED, and EDA_ITEM::m_flags.

Referenced by PCB_EDIT_FRAME::OpenProjectFiles().

IsMoving()

bool EDA_ITEM::IsMoving ( ) const

inlineinherited

Definition at line 119 of file eda_item.h.

{ return m_flags & IS_MOVING; }

References IS_MOVING, and EDA_ITEM::m_flags.

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

IsNew()

bool EDA_ITEM::IsNew ( ) const

inlineinherited

Definition at line 118 of file eda_item.h.

{ return m_flags & IS_NEW; }

References IS_NEW, and EDA_ITEM::m_flags.

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

IsReadOnly()

bool SCH_SCREEN::IsReadOnly ( ) const

inline

Definition at line 148 of file sch_screen.h.

{ return m_isReadOnly; }

References m_isReadOnly.

Referenced by SCH_EDIT_FRAME::UpdateTitle().

IsReplaceable()

virtual bool EDA_ITEM::IsReplaceable ( ) const

inlinevirtualinherited

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

Returns

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

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

Definition at line 402 of file eda_item.h.

{ return false; }

Referenced by EDA_ITEM::Matches().

IsResized()

bool EDA_ITEM::IsResized ( ) const

inlineinherited

Definition at line 124 of file eda_item.h.

{ return m_flags & IS_RESIZING; }

References IS_RESIZING, and EDA_ITEM::m_flags.

IsSelected()

bool EDA_ITEM::IsSelected ( ) const

inlineinherited

Definition at line 122 of file eda_item.h.

{ return m_flags & SELECTED; }

References EDA_ITEM::m_flags, and SELECTED.

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

IsTerminalPoint()

bool SCH_SCREEN::IsTerminalPoint	(	const wxPoint &	aPosition,
		int	aLayer
	)		const

Test if aPosition is a connection point on aLayer.

Parameters

[in]	aPosition	Position to test.
	aLayer	The layer type to test against. Valid layer types are LAYER_NOTES, LAYER_BUS, and LAYER_WIRE.

Returns

True if Position is a connection point on aLayer.

Definition at line 545 of file sch_screen.cpp.

{
 wxCHECK_MSG( aLayer == LAYER_NOTES || aLayer == LAYER_BUS || aLayer == LAYER_WIRE, false,
 wxT( "Invalid layer type passed to SCH_SCREEN::IsTerminalPoint()." ) );

 switch( aLayer )
 {
 case LAYER_BUS:
 {
 if( GetBus( aPosition ) )
 return true;

 SCH_SHEET_PIN* sheetPin = GetSheetPin( aPosition );

 if( sheetPin && sheetPin->IsConnected( aPosition ) )
 return true;

 SCH_TEXT* label = GetLabel( aPosition );

 if( label && label->IsConnected( aPosition ) )
 return true;
 }
 break;

 case LAYER_NOTES:
 {
 if( GetLine( aPosition ) )
 return true;
 }
 break;

 case LAYER_WIRE:
 {
 if( GetItem( aPosition, 1, SCH_BUS_WIRE_ENTRY_T) )
 return true;

 if( GetItem( aPosition, 1, SCH_JUNCTION_T ) )
 return true;

 if( GetPin( aPosition, nullptr, true ) )
 return true;

 if( GetWire( aPosition ) )
 return true;

 SCH_TEXT* label = GetLabel( aPosition, 1 );

 if( label && label->IsConnected( aPosition ) )
 return true;

 SCH_SHEET_PIN* sheetPin = GetSheetPin( aPosition );

 if( sheetPin && sheetPin->IsConnected( aPosition ) )
 return true;
 }
 break;

 default:
 break;
 }

 return false;
}

References GetBus(), GetItem(), GetLabel(), GetLine(), GetPin(), GetSheetPin(), GetWire(), SCH_ITEM::IsConnected(), LAYER_BUS, LAYER_NOTES, LAYER_WIRE, SCH_BUS_WIRE_ENTRY_T, and SCH_JUNCTION_T.

Referenced by SCH_LINE_WIRE_BUS_TOOL::doDrawSegments(), and SCH_ALTIUM_PLUGIN::ParsePort().

IsType()

virtual bool EDA_ITEM::IsType ( const 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 PCB_VIA, SCH_LABEL, PCB_DIMENSION_BASE, PAD, SCH_FIELD, FP_TEXT, SCH_LINE, PCB_SHAPE, FP_SHAPE, and PCB_TEXT.

Definition at line 182 of file eda_item.h.

 {
 if( aScanTypes[0] == SCH_LOCATE_ANY_T )
 return true;

 for( const KICAD_T* p = aScanTypes; *p != EOT; ++p )
 {
 if( m_structType == *p )
 return true;
 }

 return false;
 }

References EOT, EDA_ITEM::m_structType, and SCH_LOCATE_ANY_T.

Referenced by SCH_EDIT_TOOL::AutoplaceFields(), ROUTER_TOOL::CanInlineDrag(), SCH_LINE_WIRE_BUS_TOOL::IsDrawingBus(), SCH_LINE_WIRE_BUS_TOOL::IsDrawingLine(), SCH_LINE_WIRE_BUS_TOOL::IsDrawingWire(), PCB_TEXT::IsType(), FP_SHAPE::IsType(), PCB_SHAPE::IsType(), SCH_LINE::IsType(), FP_TEXT::IsType(), SCH_FIELD::IsType(), PAD::IsType(), PCB_DIMENSION_BASE::IsType(), SCH_LABEL::IsType(), PCB_VIA::IsType(), EE_POINT_EDITOR::Main(), PL_POINT_EDITOR::Main(), EE_SELECTION_TOOL::RequestSelection(), SCH_BASE_FRAME::UpdateItem(), EDA_ITEM::Visit(), and DIALOG_GLOBAL_EDIT_TEXT_AND_GRAPHICS::visitItem().

IsWireImage()

bool EDA_ITEM::IsWireImage ( ) const

inlineinherited

Definition at line 121 of file eda_item.h.

{ return m_flags & IS_WIRE_IMAGE; }

References IS_WIRE_IMAGE, and EDA_ITEM::m_flags.

Items() [1/2]

EE_RTREE& SCH_SCREEN::Items ( )

inline

Gets the full RTree, usually for iterating.

N.B. The iteration order of the RTree is not readily apparent and will change if/when you add or move items and the RTree is re-balanced. Any exposure of the RTree contents to the user MUST be sorted before being presented. See SCH_SEXPR_PLUGIN::Format or SCH_EDITOR_CONTROL::nextMatch for examples.

Returns

Complete RTree of the screen's items

Definition at line 110 of file sch_screen.h.

{ return m_rtree; }

References m_rtree.

Referenced by SCH_EAGLE_PLUGIN::addBusEntries(), SCH_MOVE_TOOL::AlignElements(), SCH_SHEET_LIST::AnnotatePowerSymbols(), SCH_EDIT_FRAME::BreakSegments(), SCH_EDIT_FRAME::BreakSegmentsOnJunctions(), CONNECTION_GRAPH::buildConnectionGraph(), SCH_SCREENS::buildScreenList(), SCH_SCREENS::ChangeSymbolLibNickname(), SCH_SHEET::CleanupSheet(), ClearAnnotation(), ClearDrawingState(), EE_COLLECTOR::Collect(), CountConnectedItems(), SCH_SHEET::CountSheets(), SCH_EDIT_FRAME::DeleteAnnotation(), SCH_EDIT_FRAME::DeleteJunction(), KIGFX::SCH_VIEW::DisplaySheet(), doIsJunction(), EnsureAlternateReferencesExist(), CONNECTION_GRAPH::ercCheckHierSheets(), SCH_SHEET_LIST::FillItemMap(), SCH_EDITOR_CONTROL::FindSymbolAndItem(), SCH_LINE_WIRE_BUS_TOOL::finishSegments(), SCH_EDIT_FRAME::FixupJunctions(), SCH_SEXPR_PLUGIN::Format(), SCH_LEGACY_PLUGIN::Format(), SCH_MOVE_TOOL::getConnectedDragItems(), GetHierarchicalItems(), GetItem(), SCH_SHEET_LIST::GetItem(), GetLabel(), GetLine(), GetPin(), AUTOPLACER::getPossibleCollisions(), getSheetBbox(), SCH_LINE_WIRE_BUS_TOOL::getSheetPin(), GetSheetPin(), GetSheets(), SCH_SHEET::HasUndefinedPins(), SCH_DRAWING_TOOLS::importHierLabel(), SCH_EDIT_TOOL::Init(), CADSTAR_SCH_ARCHIVE_LOADER::Load(), SCH_SEXPR_PLUGIN::loadHierarchy(), SCH_LEGACY_PLUGIN::loadHierarchy(), SCH_EAGLE_PLUGIN::loadSheet(), SCH_SHEET::LocatePathOfScreen(), SCH_MOVE_TOOL::Main(), EDIT_POINTS_FACTORY::Make(), NETLIST_EXPORTER_XML::makeSymbols(), MarkConnections(), SCH_EAGLE_PLUGIN::moveLabels(), SCH_EDITOR_CONTROL::nextMatch(), DIALOG_SHEET_PIN_PROPERTIES::onComboBox(), DIALOG_ERC::OnERCItemRClick(), SCH_EDITOR_CONTROL::Paste(), Plot(), Print(), DIALOG_CHANGE_SYMBOLS::processMatchingSymbols(), NETLIST_EXPORTER_PSPICE::ProcessNetlist(), EE_SELECTION_TOOL::RebuildSelection(), DIALOG_SYMBOL_REMAP::remapSymbolsToLibTable(), Remove(), SCH_EDITOR_CONTROL::RepairSchematic(), SCH_EDIT_FRAME::SaveProject(), SCH_EDIT_FRAME::SchematicCleanUp(), SCH_SHEET::SearchHierarchy(), SetConnectivityDirty(), SCH_EDIT_FRAME::setupUIConditions(), SCH_SHEET::SymbolCount(), TestDanglingEnds(), ERC_TESTER::TestDuplicateSheetNames(), DIALOG_ERC::testErc(), ERC_TESTER::TestTextVars(), DIALOG_SHEET_PROPERTIES::TransferDataFromWindow(), DIALOG_GLOBAL_EDIT_TEXT_AND_GRAPHICS::TransferDataFromWindow(), DIALOG_SHEET_PIN_PROPERTIES::TransferDataToWindow(), SCH_EDIT_FRAME::TrimWire(), DIALOG_CHANGE_SYMBOLS::updateFieldsList(), SCH_EDITOR_CONTROL::UpdateFind(), UpdateLocalLibSymbolLinks(), SCH_EDITOR_CONTROL::UpdateNetHighlighting(), SCH_EDITOR_CONTROL::updatePastedSheet(), UpdateSymbolLinks(), SIM_PLOT_FRAME::UpdateTunerValue(), and NETLIST_EXPORTER_ORCADPCB2::WriteNetlist().

Items() [2/2]

const EE_RTREE& SCH_SCREEN::Items ( ) const

inline

Definition at line 111 of file sch_screen.h.

{ return m_rtree; }

References m_rtree.

IterateForward() [1/2]

template<class T >

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

inlinestaticinherited

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

Definition at line 294 of file eda_item.h.

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

 return SEARCH_RESULT::CONTINUE;
 }

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

Referenced by GERBER_FILE_IMAGE::Visit().

IterateForward() [2/2]

template<class T >

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

inlinestaticinherited

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

Definition at line 313 of file eda_item.h.

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

 return SEARCH_RESULT::CONTINUE;
 }

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

MarkConnections()

std::set< SCH_ITEM * > SCH_SCREEN::MarkConnections

(

SCH_LINE *

aSegment

)

Return all wires and junctions connected to aSegment which are not connected any symbol pin.

Parameters

aSegment

The segment to test for connections.

Definition at line 358 of file sch_screen.cpp.

{
 std::set<SCH_ITEM*> retval;
 std::stack<SCH_LINE*> to_search;

 wxCHECK_MSG( aSegment && aSegment->Type() == SCH_LINE_T, retval, wxT( "Invalid pointer." ) );

 to_search.push( aSegment );

 while( !to_search.empty() )
 {
 SCH_LINE* test_item = to_search.top();
 to_search.pop();

 for( SCH_ITEM* item : Items().Overlapping( SCH_JUNCTION_T, test_item->GetBoundingBox() ) )
 {
 if( test_item->IsEndPoint( item->GetPosition() ) )
 retval.insert( item );
 }

 for( SCH_ITEM* item : Items().Overlapping( SCH_LINE_T, test_item->GetBoundingBox() ) )
 {
 // Skip connecting lines on different layers (e.g. buses)
 if( test_item->GetLayer() != item->GetLayer() )
 continue;

 SCH_LINE* line = static_cast<SCH_LINE*>( item );

 if( ( test_item->IsEndPoint( line->GetStartPoint() )
 && !GetPin( line->GetStartPoint(), nullptr, true ) )
 || ( test_item->IsEndPoint( line->GetEndPoint() )
 && !GetPin( line->GetEndPoint(), nullptr, true ) ) )
 {
 auto result = retval.insert( line );

 if( result.second )
 to_search.push( line );
 }
 }
 }

 return retval;
}

References SCH_LINE::GetBoundingBox(), SCH_LINE::GetEndPoint(), SCH_ITEM::GetLayer(), GetPin(), SCH_LINE::GetStartPoint(), SCH_LINE::IsEndPoint(), Items(), SCH_JUNCTION_T, SCH_LINE_T, and EDA_ITEM::Type().

Referenced by EE_SELECTION_TOOL::SelectConnection().

Matches() [1/2]

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

inlinevirtualinherited

Compare the item against the search criteria in aSearchData.

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

Parameters

aSearchData	A reference to a wxFindReplaceData object containing the search criteria.
aAuxData	A pointer to optional data required for the search or NULL if not used.

Returns

True if the item's text matches the search criteria in aSearchData.

Reimplemented in SCH_SYMBOL, SCH_SHEET, SCH_TEXT, SCH_FIELD, SCH_SHEET_PIN, ZONE, SCH_PIN, PCB_MARKER, SCH_MARKER, FP_TEXT, and PCB_TEXT.

Definition at line 364 of file eda_item.h.

 {
 return false;
 }

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

Matches() [2/2]

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

protectedinherited

Compare aText against search criteria in aSearchData.

This is a helper function for simplify derived class logic.

Parameters

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

Returns

True if aText matches the search criteria in aSearchData.

Definition at line 118 of file eda_item.cpp.

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

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

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

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

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

 if( next == wxNOT_FOUND )
 return false;

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

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

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

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

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

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

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

 return false;
}

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

Plot()

void SCH_SCREEN::Plot

(

PLOTTER *

aPlotter

)

const

Plot all the schematic objects to aPlotter.

Note

This function is useful only for schematic. The library editor and library viewer do not use a draw list and therefore plots nothing.

Parameters

[in]

aPlotter

The plotter object to plot to.

Sort to ensure plot-order consistency with screen drawing

Definition at line 838 of file sch_screen.cpp.

{
 // Ensure links are up to date, even if a library was reloaded for some reason:
 std::vector< SCH_ITEM* > junctions;
 std::vector< SCH_ITEM* > bitmaps;
 std::vector< SCH_ITEM* > other;

 for( SCH_ITEM* item : Items() )
 {
 if( item->IsMoving() || item->IsResized() )
 continue;

 if( item->Type() == SCH_JUNCTION_T )
 junctions.push_back( item );
 else if( item->Type() == SCH_BITMAP_T )
 bitmaps.push_back( item );
 else
 other.push_back( item );
 }

 std::sort( other.begin(), other.end(),
 []( const SCH_ITEM* a, const SCH_ITEM* b )
 {
 if( a->Type() == b->Type() )
 return a->GetLayer() > b->GetLayer();

 return a->Type() > b->Type();
 } );

 int defaultPenWidth = aPlotter->RenderSettings()->GetDefaultPenWidth();

 // Bitmaps are drawn first to ensure they are in the background
 // This is particularly important for the wxPostscriptDC (used in *nix printers) as
 // the bitmap PS command clears the screen
 for( const SCH_ITEM* item : bitmaps )
 {
 aPlotter->SetCurrentLineWidth( std::max( item->GetPenWidth(), defaultPenWidth ) );
 item->Plot( aPlotter );
 }

 for( const SCH_ITEM* item : other )
 {
 aPlotter->SetCurrentLineWidth( std::max( item->GetPenWidth(), defaultPenWidth ) );
 item->Plot( aPlotter );
 }

 for( const SCH_ITEM* item : junctions )
 {
 aPlotter->SetCurrentLineWidth( std::max( item->GetPenWidth(), defaultPenWidth ) );
 item->Plot( aPlotter );
 }
}

References KIGFX::RENDER_SETTINGS::GetDefaultPenWidth(), SCH_ITEM::GetLayer(), Items(), PLOTTER::RenderSettings(), SCH_BITMAP_T, SCH_JUNCTION_T, PLOTTER::SetCurrentLineWidth(), and EDA_ITEM::Type().

Referenced by DIALOG_PLOT_SCHEMATIC::plotOneSheetDXF(), DIALOG_PLOT_SCHEMATIC::plotOneSheetHpgl(), DIALOG_PLOT_SCHEMATIC::plotOneSheetPDF(), DIALOG_PLOT_SCHEMATIC::plotOneSheetPS(), and DIALOG_PLOT_SCHEMATIC::plotOneSheetSVG().

Print()

void SCH_SCREEN::Print

(

const RENDER_SETTINGS *

aSettings

)

Print all the items in the screen to aDC.

Note

This function is useful only for schematic. The library editor and library viewer do not use a draw list and therefore draws nothing.

Sort to ensure plot-order consistency with screen drawing

Definition at line 797 of file sch_screen.cpp.

{
 // Ensure links are up to date, even if a library was reloaded for some reason:
 std::vector<SCH_ITEM*> junctions;
 std::vector<SCH_ITEM*> bitmaps;
 std::vector<SCH_ITEM*> other;

 for( SCH_ITEM* item : Items() )
 {
 if( item->IsMoving() || item->IsResized() )
 continue;

 if( item->Type() == SCH_JUNCTION_T )
 junctions.push_back( item );
 else if( item->Type() == SCH_BITMAP_T )
 bitmaps.push_back( item );
 else
 other.push_back( item );
 }

 std::sort( other.begin(), other.end(),
 []( const SCH_ITEM* a, const SCH_ITEM* b )
 {
 if( a->Type() == b->Type() )
 return a->GetLayer() > b->GetLayer();

 return a->Type() > b->Type();
 } );

 for( SCH_ITEM* item : bitmaps )
 item->Print( aSettings, wxPoint( 0, 0 ) );

 for( SCH_ITEM* item : other )
 item->Print( aSettings, wxPoint( 0, 0 ) );

 for( SCH_ITEM* item : junctions )
 item->Print( aSettings, wxPoint( 0, 0 ) );
}

References SCH_ITEM::GetLayer(), Items(), SCH_BITMAP_T, SCH_JUNCTION_T, and EDA_ITEM::Type().

Referenced by SCH_PRINTOUT::PrintPage(), and SCH_EDIT_FRAME::PrintPage().

Remove()

bool SCH_SCREEN::Remove

(

SCH_ITEM *

aItem

)

Remove aItem from the schematic associated with this screen.

Note

The removed item is not deleted. It is only unlinked from the item list.

Parameters

[in]

aItem

Item to be removed from schematic.

Returns

True if we successfully removed the item

Definition at line 273 of file sch_screen.cpp.

{
 bool retv = m_rtree.remove( aItem );

 // Check if the library symbol for the removed schematic symbol is still required.
 if( retv && aItem->Type() == SCH_SYMBOL_T )
 {
 SCH_SYMBOL* removedSymbol = static_cast<SCH_SYMBOL*>( aItem );

 bool removeUnusedLibSymbol = true;

 for( SCH_ITEM* item : Items().OfType( SCH_SYMBOL_T ) )
 {
 SCH_SYMBOL* symbol = static_cast<SCH_SYMBOL*>( item );

 if( removedSymbol->GetSchSymbolLibraryName() == symbol->GetSchSymbolLibraryName() )
 {
 removeUnusedLibSymbol = false;
 break;
 }
 }

 if( removeUnusedLibSymbol )
 {
 auto it = m_libSymbols.find( removedSymbol->GetSchSymbolLibraryName() );

 if( it != m_libSymbols.end() )
 {
 delete it->second;
 m_libSymbols.erase( it );
 }
 }
 }

 return retv;
}

References SCH_SYMBOL::GetSchSymbolLibraryName(), Items(), m_libSymbols, m_rtree, EE_RTREE::remove(), SCH_SYMBOL_T, and EDA_ITEM::Type().

Referenced by SCH_SHEET_LIST::BuildSheetList(), DeleteItem(), DIALOG_SHEET_PROPERTIES::onSheetFilenameChanged(), DIALOG_CHANGE_SYMBOLS::processSymbol(), SCH_EDIT_FRAME::SaveSymbolToSchematic(), DIALOG_SYMBOL_PROPERTIES::TransferDataFromWindow(), Update(), and UpdateSymbolLinks().

Replace() [1/2]

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

staticinherited

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

Parameters

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

Returns

True if aText was modified, otherwise false.

Definition at line 170 of file eda_item.cpp.

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

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

 int ii = 0;

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

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

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

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

 bool startOK;
 bool endOK;

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

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

 aText = result;
 return replaced;
}

References next(), and text.

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

Replace() [2/2]

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

inlinevirtualinherited

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

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

Parameters

aSearchData	A reference to a wxFindReplaceData object containing the search and replace criteria.
aAuxData	A pointer to optional data required for the search or NULL if not used.

Returns

True if the item text was modified, otherwise false.

Reimplemented in SCH_TEXT, SCH_FIELD, SCH_SHEET_PIN, and SCH_PIN.

Definition at line 391 of file eda_item.h.

 {
 return false;
 }

Schematic()

SCHEMATIC * SCH_SCREEN::Schematic

(

)

const

Definition at line 92 of file sch_screen.cpp.

{
 wxCHECK_MSG( GetParent() && GetParent()->Type() == SCHEMATIC_T, nullptr,
 "SCH_SCREEN must have a SCHEMATIC parent!" );

 return static_cast<SCHEMATIC*>( GetParent() );
}

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

Referenced by SCH_SCREENS::BuildClientSheetPathList(), SCH_SCREENS::ClearAnnotationOfNewSheetPaths(), KIGFX::SCH_VIEW::DisplaySheet(), DIALOG_PLOT_SCHEMATIC::plotOneSheetPDF(), DIALOG_PLOT_SCHEMATIC::plotOneSheetPS(), DIALOG_PLOT_SCHEMATIC::plotOneSheetSVG(), RESCUER::RESCUER(), SCH_SHEET_PATH::TestForRecursion(), UpdateSymbolLinks(), and SCH_SCREENS::UpdateSymbolLinks().

Set() [1/3]

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

inlineinherited

Definition at line 42 of file inspectable.h.

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

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

 return object != nullptr;
 }

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

Set() [2/3]

template<typename T >

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

inlineinherited

Definition at line 55 of file inspectable.h.

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

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

 return object != nullptr;
 }

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

Set() [3/3]

template<typename T >

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

inlineinherited

Definition at line 68 of file inspectable.h.

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

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

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

 return object != nullptr;
 }

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

SetAuxOrigin()

void SCH_SCREEN::SetAuxOrigin ( const wxPoint &  aPosition )

inline

Definition at line 154 of file sch_screen.h.

{ m_aux_origin = aPosition; }

References m_aux_origin.

SetBrightened()

void EDA_ITEM::SetBrightened ( )

inlineinherited

Definition at line 129 of file eda_item.h.

{ SetFlags( BRIGHTENED ); }

References BRIGHTENED, and EDA_ITEM::SetFlags().

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

SetConnectivityDirty()

void SCH_SCREEN::SetConnectivityDirty

(

)

Definition at line 790 of file sch_screen.cpp.

{
 for( SCH_ITEM* item : Items() )
 item->SetConnectivityDirty( true );
}

References Items().

Referenced by SCH_EDIT_FRAME::OnModify().

SetContentModified()

void BASE_SCREEN::SetContentModified ( bool  aModified = true )

inlineinherited

Definition at line 59 of file base_screen.h.

{ m_flagModified = aModified; }

References BASE_SCREEN::m_flagModified.

Referenced by SCH_EDIT_FRAME::AddItemToScreenAndUndoList(), SCH_SHEET_LIST::BuildSheetList(), FOOTPRINT_EDIT_FRAME::Clear_Pcb(), PCB_EDIT_FRAME::Clear_Pcb(), SYMBOL_LIBRARY_MANAGER::ClearLibraryModified(), FOOTPRINT_EDIT_FRAME::ClearModify(), SCH_SHEET_LIST::ClearModifyStatus(), FOOTPRINT_EDITOR_CONTROL::CreateFootprint(), DeleteItem(), PCB_EDIT_FRAME::doAutoSave(), SCH_EDIT_FRAME::doAutoSave(), PCB_EDIT_FRAME::ExportSpecctraFile(), PL_EDITOR_FRAME::Files_io(), PCB_EDIT_FRAME::Files_io_from_id(), SCH_EDIT_FRAME::importFile(), SCH_EDIT_FRAME::InitSheet(), PL_EDITOR_FRAME::LoadDrawingSheetFile(), SCH_LEGACY_PLUGIN::loadSymbol(), FOOTPRINT_EDITOR_CONTROL::NewFootprint(), SCH_EDIT_FRAME::OnModify(), SYMBOL_EDIT_FRAME::OnModify(), PL_EDITOR_FRAME::OnModify(), PCB_BASE_FRAME::OnModify(), PL_EDITOR_FRAME::OnNewDrawingSheet(), PCB_EDIT_FRAME::OpenProjectFiles(), SCH_EDIT_FRAME::OpenProjectFiles(), SCH_SEXPR_PARSER::parseSchSheetInstances(), DIALOG_SYMBOL_REMAP::remapSymbolsToLibTable(), FOOTPRINT_EDIT_FRAME::RevertFootprint(), SYMBOL_EDIT_FRAME::Save(), PL_EDITOR_FRAME::SaveDrawingSheetFile(), PCB_EDIT_FRAME::SavePcbFile(), SCH_EDIT_FRAME::saveSchematicFile(), DIALOG_PAGES_SETTINGS::TransferDataFromWindow(), and SYMBOL_LIBRARY_MANAGER::UpdateSymbol().

SetFileExists()

void SCH_SCREEN::SetFileExists ( bool  aFileExists )

inline

Definition at line 150 of file sch_screen.h.

{ m_fileExists = aFileExists; }

References m_fileExists.

Referenced by SCH_SEXPR_PLUGIN::loadHierarchy(), SCH_LEGACY_PLUGIN::loadHierarchy(), SCH_SEXPR_PLUGIN::Save(), and SCH_LEGACY_PLUGIN::Save().

SetFileFormatVersionAtLoad()

void SCH_SCREEN::SetFileFormatVersionAtLoad ( int  aVersion )

inline

Definition at line 129 of file sch_screen.h.

{ m_fileFormatVersionAtLoad = aVersion; }

References m_fileFormatVersionAtLoad.

Referenced by SCH_SEXPR_PARSER::ParseSchematic().

SetFileName()

void SCH_SCREEN::SetFileName

(

const wxString &

aFileName

)

Set the file name for this screen to aFileName.

Note

Screen file names must be absolute or empty. Absolute file names do not have to exist yet in the case of a new schematic file but file names cannot be relative.

Parameters

aFileName

is the absolute file name and path of the screen.

Definition at line 110 of file sch_screen.cpp.

{
 wxASSERT( aFileName.IsEmpty() || wxIsAbsolutePath( aFileName ) );

 m_fileName = aFileName;
}

References m_fileName.

Referenced by SCH_EDIT_FRAME::CreateScreens(), SCH_EDIT_FRAME::importFile(), SCH_EDIT_FRAME::InitSheet(), CADSTAR_SCH_ARCHIVE_PLUGIN::Load(), SCH_ALTIUM_PLUGIN::Load(), SCH_EAGLE_PLUGIN::Load(), SCH_SEXPR_PLUGIN::loadHierarchy(), SCH_LEGACY_PLUGIN::loadHierarchy(), SCH_EAGLE_PLUGIN::loadSheet(), CADSTAR_SCH_ARCHIVE_LOADER::loadSheets(), DIALOG_SHEET_PROPERTIES::onSheetFilenameChanged(), SCH_EDIT_FRAME::OpenProjectFiles(), SCH_EDIT_FRAME::SaveProject(), and DIALOG_SHEET_PROPERTIES::TransferDataFromWindow().

SetFileReadOnly()

void SCH_SCREEN::SetFileReadOnly ( bool  aIsReadOnly )

inline

Definition at line 147 of file sch_screen.h.

{ m_isReadOnly = aIsReadOnly; }

References m_isReadOnly.

Referenced by SCH_SEXPR_PLUGIN::loadHierarchy(), and SCH_LEGACY_PLUGIN::loadHierarchy().

SetFlags()

void EDA_ITEM::SetFlags ( EDA_ITEM_FLAGS  aMask )

inlineinherited

Definition at line 152 of file eda_item.h.

{ m_flags |= aMask; }

References EDA_ITEM::m_flags.

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

SetForceVisible()

void EDA_ITEM::SetForceVisible ( bool  aEnable )

inlineinherited

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

Parameters

aEnable

True forces the item to be drawn. False uses the item's visibility setting to determine if the item is to be drawn.

Definition at line 203 of file eda_item.h.

{ m_forceVisible = aEnable; }

References EDA_ITEM::m_forceVisible.

Referenced by SCH_EDITOR_CONTROL::UpdateFind().

SetModified()

void EDA_ITEM::SetModified ( )

inherited

Definition at line 65 of file eda_item.cpp.

{
 SetFlags( IS_CHANGED );

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

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

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

SetPageCount()

void BASE_SCREEN::SetPageCount ( int  aPageCount )

inherited

Definition at line 63 of file base_screen.cpp.

{
 wxCHECK( aPageCount > 0, /* void */ );

 m_pageCount = aPageCount;
}

References BASE_SCREEN::m_pageCount.

Referenced by SCH_LEGACY_PLUGIN::loadPageSettings(), and SCH_EDIT_FRAME::SetSheetNumberAndCount().

SetPageNumber()

void BASE_SCREEN::SetPageNumber ( const wxString &  aPageNumber )

inlineinherited

Definition at line 79 of file base_screen.h.

{ m_pageNumber = aPageNumber; }

References BASE_SCREEN::m_pageNumber.

Referenced by SCH_EDIT_FRAME::CreateScreens(), SCH_EDIT_TOOL::EditPageNumber(), and SCH_EDIT_FRAME::SetSheetNumberAndCount().

SetPageSettings()

void SCH_SCREEN::SetPageSettings ( const PAGE_INFO &  aPageSettings )

inline

Definition at line 133 of file sch_screen.h.

{ m_paper = aPageSettings; }

References m_paper.

Referenced by SYMBOL_EDITOR_CONTROL::ExportSymbolAsSVG(), CADSTAR_SCH_ARCHIVE_LOADER::Load(), SCH_LEGACY_PLUGIN::loadPageSettings(), SCH_EAGLE_PLUGIN::loadSheet(), SCH_SEXPR_PARSER::ParseSchematic(), SCH_ALTIUM_PLUGIN::ParseSheet(), and SCH_BASE_FRAME::SetPageSettings().

SetParent()

virtual void EDA_ITEM::SetParent ( EDA_ITEM *  aParent )

inlinevirtualinherited

Reimplemented in PCB_DIMENSION_BASE.

Definition at line 115 of file eda_item.h.

{ m_parent = aParent; }

References EDA_ITEM::m_parent.

Referenced by FOOTPRINT::Add(), BOARD::Add(), FOOTPRINT_VIEWER_FRAME::AddFootprintToPCB(), BOARD_NETLIST_UPDATER::addNewFootprint(), SCH_SHEET::AddPin(), PAD::AddPrimitive(), PAD::AddPrimitiveArc(), PAD::AddPrimitiveCircle(), PAD::AddPrimitiveCurve(), PAD::AddPrimitivePoly(), PAD::AddPrimitiveRect(), PAD::AddPrimitiveSegment(), SYMBOL_EDITOR_CONTROL::AddSymbolToSchematic(), Append(), LIB_FIELD::Copy(), SYMBOL_EDIT_FRAME::CreateNewSymbol(), SCH_DRAWING_TOOLS::createNewText(), DIALOG_PAD_PROPERTIES::DIALOG_PAD_PROPERTIES(), SCH_LINE_WIRE_BUS_TOOL::doUnfoldBus(), SYMBOL_EDITOR_DRAWING_TOOLS::DrawShape(), PCB_EDIT_FRAME::ExchangeFootprint(), LIB_SYMBOL::Flatten(), FOOTPRINT::FOOTPRINT(), PCB_PLUGIN::FootprintSave(), DISPLAY_FOOTPRINTS_FRAME::GetFootprint(), CADSTAR_SCH_ARCHIVE_LOADER::getKiCadSchText(), LIB_SYMBOL::LIB_SYMBOL(), SCH_LEGACY_PLUGIN_CACHE::loadAliases(), CADSTAR_SCH_ARCHIVE_LOADER::loadChildSheets(), FOOTPRINT_EDIT_FRAME::LoadFootprintFromBoard(), SCH_SEXPR_PLUGIN::loadHierarchy(), SCH_LEGACY_PLUGIN::loadHierarchy(), FOOTPRINT::operator=(), LIB_SYMBOL::operator=(), PCB_PARSER::parseFOOTPRINT_unchecked(), SCH_SEXPR_PARSER::ParseSchematic(), SCH_SEXPR_PARSER::ParseSymbol(), SYMBOL_EDITOR_EDIT_TOOL::Paste(), PCB_CONTROL::Paste(), SCH_EDITOR_CONTROL::Paste(), pasteFootprintItemsToFootprintEditor(), BOARD_EDITOR_CONTROL::PlaceFootprint(), BACK_ANNOTATE::processNetNameChange(), BOARD_COMMIT::Push(), SCH_SEXPR_PLUGIN_CACHE::removeSymbol(), SCH_LEGACY_PLUGIN_CACHE::removeSymbol(), PCB_BASE_EDIT_FRAME::SaveCopyInUndoList(), SaveCopyOfZones(), FOOTPRINT_EDIT_FRAME::SaveFootprintToBoard(), SCH_SHEET_PIN::SCH_SHEET_PIN(), LIB_SYMBOL::SetFields(), PCB_DIMENSION_BASE::SetParent(), SCH_DRAWING_TOOLS::SingleClickPlace(), SCH_LINE_WIRE_BUS_TOOL::startSegments(), SCH_SHEET::SwapData(), SCH_GLOBALLABEL::SwapData(), SCH_SYMBOL::SwapData(), and SwapItemData().

SetPosition()

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

inlinevirtualinherited

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

Definition at line 252 of file eda_item.h.

{};

Referenced by BOARD_EDITOR_CONTROL::DoSetDrillOrigin(), PCB_CONTROL::DoSetGridOrigin(), DRAWING_TOOL::DrawVia(), FOOTPRINT::GetFpPadsLocalBbox(), ALTIUM_PCB::ParseTexts6Data(), PL_DRAWING_TOOLS::PlaceItem(), PlotStandardLayer(), BOARD_ITEM::SetX(), BOARD_ITEM::SetY(), SCH_DRAWING_TOOLS::SingleClickPlace(), and SCH_DRAWING_TOOLS::TwoClickPlace().

SetSelected()

void EDA_ITEM::SetSelected ( )

inlineinherited

Definition at line 128 of file eda_item.h.

{ SetFlags( SELECTED ); }

References SELECTED, and EDA_ITEM::SetFlags().

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

SetState()

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

inlineinherited

Definition at line 141 of file eda_item.h.

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

References EDA_ITEM::m_status.

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

SetStatus()

void EDA_ITEM::SetStatus ( EDA_ITEM_FLAGS  aStatus )

inlineinherited

Definition at line 150 of file eda_item.h.

{ m_status = aStatus; }

References EDA_ITEM::m_status.

Referenced by BOARD_NETLIST_UPDATER::UpdateNetlist().

SetTitleBlock()

void SCH_SCREEN::SetTitleBlock ( const TITLE_BLOCK &  aTitleBlock )

inline

Definition at line 158 of file sch_screen.h.

{ m_titles = aTitleBlock; }

References m_titles.

Referenced by SCH_LEGACY_PLUGIN::loadPageSettings(), SCH_ALTIUM_PLUGIN::ParseFileHeader(), SCH_SEXPR_PARSER::ParseSchematic(), and SCH_BASE_FRAME::SetTitleBlock().

SetVirtualPageNumber()

void BASE_SCREEN::SetVirtualPageNumber ( int  aPageNumber )

inlineinherited

Definition at line 76 of file base_screen.h.

{ m_virtualPageNumber = aPageNumber; }

References BASE_SCREEN::m_virtualPageNumber.

Referenced by SCH_LEGACY_PLUGIN::loadPageSettings(), PLEDITOR_PRINTOUT::PrintPage(), PL_EDITOR_FRAME::PrintPage(), SCH_EDIT_FRAME::SaveProject(), and SCH_EDIT_FRAME::SetSheetNumberAndCount().

SetWireImage()

void EDA_ITEM::SetWireImage ( )

inlineinherited

Definition at line 127 of file eda_item.h.

{ SetFlags( IS_WIRE_IMAGE ); }

References IS_WIRE_IMAGE, and EDA_ITEM::SetFlags().

Sort()

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

inlinestaticinherited

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

Parameters

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

Returns

True if aLeft is less than aRight.

Definition at line 420 of file eda_item.h.

{ return *aLeft < *aRight; }

TestDanglingEnds()

void SCH_SCREEN::TestDanglingEnds	(	const SCH_SHEET_PATH *	aPath = nullptr,
		std::function< void(SCH_ITEM *)> *	aChangedHandler = nullptr
	)		const

Test all of the connectable objects in the schematic for unused connection points.

Parameters

aPath	is a sheet path to pass to UpdateDanglingState if desired.
aChangedHandler	is an optional callback to make on each changed item.

Definition at line 1046 of file sch_screen.cpp.

{
 std::vector<DANGLING_END_ITEM> endPoints;

 for( SCH_ITEM* item : Items() )
 {
 if( item->IsConnectable() )
 {
 endPoints.clear();

 for( SCH_ITEM* overlapping : Items().Overlapping( item->GetBoundingBox() ) )
 overlapping->GetEndPoints( endPoints );

 if( item->UpdateDanglingState( endPoints, aPath ) )
 {
 if( aChangedHandler )
 (*aChangedHandler)( item );
 }
 }
 }
}

References Items().

Referenced by SCH_EDITOR_CONTROL::FindNext(), SCH_EDIT_FRAME::importFile(), and SCH_EDIT_FRAME::TestDanglingEnds().

Type()

KICAD_T EDA_ITEM::Type ( ) const

inlineinherited

Returns the type of object.

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

Returns

the type of object.

Definition at line 112 of file eda_item.h.

{ return m_structType; }

References EDA_ITEM::m_structType.

Referenced by KIGFX::PCB_VIEW::Add(), FOOTPRINT::Add(), CN_CONNECTIVITY_ALGO::Add(), BOARD::Add(), CN_CLUSTER::Add(), PCB_POINT_EDITOR::addCorner(), CONNECTION_SUBGRAPH::AddItem(), SCH_EDIT_FRAME::AddItemToScreenAndUndoList(), SCH_LINE_WIRE_BUS_TOOL::AddJunctionsIfNeeded(), ZONE_FILLER::addKnockout(), SCH_SHEET::AddPin(), ALIGN_DISTRIBUTE_TOOL::AlignBottom(), ALIGN_DISTRIBUTE_TOOL::AlignCenterX(), ALIGN_DISTRIBUTE_TOOL::AlignCenterY(), ALIGN_DISTRIBUTE_TOOL::AlignTop(), CN_ITEM::AnchorCount(), Append(), CADSTAR_SCH_ARCHIVE_LOADER::applyTextSettings(), PNS::TOPOLOGY::AssembleTuningPath(), CONNECTION_GRAPH::buildConnectionGraph(), DIALOG_NET_INSPECTOR::buildNewItem(), SCH_SCREENS::buildScreenList(), calcIsInsideArea(), calcIsInsideCourtyard(), BOARD_INSPECTION_TOOL::calculateSelectionRatsnest(), PCB_POINT_EDITOR::canAddCorner(), SCH_NO_CONNECT::CanConnect(), SCH_JUNCTION::CanConnect(), SCH_BUS_WIRE_ENTRY::CanConnect(), SCH_BUS_BUS_ENTRY::CanConnect(), SCH_LINE::CanConnect(), SCH_LABEL::CanConnect(), SCH_SHEET::CanConnect(), SCH_GLOBALLABEL::CanConnect(), SCH_HIERLABEL::CanConnect(), SCH_SYMBOL::CanConnect(), CN_VISITOR::checkZoneItemConnection(), SCH_MARKER::ClassOf(), SCH_JUNCTION::ClassOf(), PCB_TEXT::ClassOf(), SCH_NO_CONNECT::ClassOf(), SCH_PIN::ClassOf(), PCB_MARKER::ClassOf(), BOARD_CONNECTED_ITEM::ClassOf(), FP_SHAPE::ClassOf(), PCB_SHAPE::ClassOf(), PCB_TARGET::ClassOf(), SCH_LINE::ClassOf(), PCB_GROUP::ClassOf(), SCH_FIELD::ClassOf(), FP_TEXT::ClassOf(), SCH_SHEET::ClassOf(), NETINFO_ITEM::ClassOf(), ZONE::ClassOf(), SCH_SHEET_PIN::ClassOf(), SCH_BITMAP::ClassOf(), PCB_TRACK::ClassOf(), PAD::ClassOf(), SCH_SYMBOL::ClassOf(), FOOTPRINT::ClassOf(), ClassOf(), SCH_TEXT::ClassOf(), SCH_BUS_WIRE_ENTRY::ClassOf(), BOARD::ClassOf(), SCH_BUS_BUS_ENTRY::ClassOf(), PCB_ARC::ClassOf(), SCH_LABEL::ClassOf(), PCB_VIA::ClassOf(), SCH_GLOBALLABEL::ClassOf(), PCB_DIM_ALIGNED::ClassOf(), PCB_DIM_ORTHOGONAL::ClassOf(), SCH_HIERLABEL::ClassOf(), PCB_DIM_LEADER::ClassOf(), PCB_DIM_CENTER::ClassOf(), TRACKS_CLEANER::cleanup(), LIB_TEXT::compare(), LIB_FIELD::compare(), LIB_PIN::compare(), LIB_ITEM::compare(), LIB_SYMBOL::Compare(), EE_GRID_HELPER::computeAnchors(), PCB_GRID_HELPER::computeAnchors(), SCH_BUS_WIRE_ENTRY::ConnectionPropagatesTo(), SCH_LINE::ConnectionPropagatesTo(), EE_RTREE::contains(), BOARD::ConvertKIIDsToCrossReferences(), SCHEMATIC::ConvertKIIDsToRefs(), PAD_TOOL::copyPadSettings(), EDIT_TOOL::copyToClipboard(), FOOTPRINT::CoverageRatio(), BOARD_ADAPTER::createLayers(), CONVERT_TOOL::CreateLines(), PCB_BASE_FRAME::CreateNewFootprint(), SCH_DRAWING_TOOLS::createNewText(), ZONE_CREATE_HELPER::createNewZone(), CONVERT_TOOL::CreatePolys(), BOARD_ADAPTER::createTrack(), DRC_TOOL::CrossProbe(), DeleteItem(), DIALOG_DIMENSION_PROPERTIES::DIALOG_DIMENSION_PROPERTIES(), DIALOG_SCH_FIELD_PROPERTIES::DIALOG_SCH_FIELD_PROPERTIES(), DIALOG_TEXT_AND_LABEL_PROPERTIES::DIALOG_TEXT_AND_LABEL_PROPERTIES(), DIALOG_TEXT_PROPERTIES::DIALOG_TEXT_PROPERTIES(), ALIGN_DISTRIBUTE_TOOL::DistributeHorizontally(), ALIGN_DISTRIBUTE_TOOL::DistributeVertically(), ALIGN_DISTRIBUTE_TOOL::doAlignLeft(), ALIGN_DISTRIBUTE_TOOL::doAlignRight(), SCH_EDITOR_CONTROL::doCopy(), SCH_EDIT_TOOL::DoDelete(), ALIGN_DISTRIBUTE_TOOL::doDistributeCentersHorizontally(), ALIGN_DISTRIBUTE_TOOL::doDistributeCentersVertically(), ALIGN_DISTRIBUTE_TOOL::doDistributeGapsHorizontally(), ALIGN_DISTRIBUTE_TOOL::doDistributeGapsVertically(), APPEARANCE_CONTROLS::doesBoardItemNeedRebuild(), EDIT_TOOL::Drag(), EDIT_TOOL::DragArcTrack(), KIGFX::SCH_PAINTER::draw(), KIGFX::GERBVIEW_PAINTER::Draw(), KIGFX::PCB_PAINTER::Draw(), DRAWING_TOOL::DrawDimension(), DRAWING_TOOL::DrawVia(), CONNECTION_SUBGRAPH::driverName(), CN_ITEM::Dump(), EDIT_TOOL::Duplicate(), FOOTPRINT::DuplicateItem(), EDA_ITEM_DESC::EDA_ITEM_DESC(), SCH_EDIT_TOOL::EditField(), SCH_EDIT_TOOL::editFieldText(), SYMBOL_EDITOR_EDIT_TOOL::editTextProperties(), CONNECTION_GRAPH::ercCheckBusToBusEntryConflicts(), CONNECTION_GRAPH::ercCheckBusToNetConflicts(), CONNECTION_GRAPH::ercCheckFloatingWires(), CONNECTION_GRAPH::ercCheckLabels(), CONNECTION_GRAPH::ercCheckMultipleDrivers(), CONNECTION_GRAPH::ercCheckNoConnects(), DRC_ENGINE::EvalRules(), EDIT_TOOL::FilletTracks(), PCB_SELECTION_TOOL::FilterCollectorForFreePads(), PCB_SELECTION_TOOL::FilterCollectorForHierarchy(), PCB_SELECTION_TOOL::FilterCollectorForMarkers(), NETLIST_EXPORTER_BASE::findNextSymbol(), CADSTAR_ARCHIVE_PARSER::FixTextPositionNoAlignment(), PCB_BASE_FRAME::FocusOnItem(), EDIT_TOOL::FootprintFilter(), SCH_SEXPR_PLUGIN::Format(), SCH_LEGACY_PLUGIN::Format(), PCB_PLUGIN::Format(), PCB_PLUGIN::format(), FormatProbeItem(), FP_TEXT::FP_TEXT(), PCB_POINT_EDITOR::get45DegConstrainer(), CN_ITEM::GetAnchor(), BOARD_ITEM::GetBoard(), PCB_TRACK::GetBoundingBox(), SCH_FIELD::GetBoundingBox(), SCH_FIELD::GetCanonicalName(), KIGFX::GERBVIEW_RENDER_SETTINGS::GetColor(), KIGFX::PCB_RENDER_SETTINGS::GetColor(), SCH_MOVE_TOOL::getConnectedDragItems(), SCH_TEXT::GetConnectionPoints(), SCH_TEXT::GetContextualTextVars(), FOOTPRINT::GetCoverageArea(), CONNECTION_GRAPH::getDefaultConnection(), SCH_FIELD::GetDrawRotation(), getDrilledHoleShape(), CONNECTION_SUBGRAPH::GetDriverPriority(), SCH_TEXT::GetEndPoints(), PL_EDITOR_FRAME::GetLayoutFromRedoList(), PL_EDITOR_FRAME::GetLayoutFromUndoList(), SCH_FIELD::GetMenuImage(), getMinDist(), PCB_TRACK::GetMsgPanelInfo(), PCB_DIMENSION_BASE::GetMsgPanelInfo(), SCH_TEXT::GetMsgPanelInfo(), SCH_FIELD::GetName(), CONNECTIVITY_DATA::GetNetItems(), LIB_SYMBOL::GetNextDrawItem(), PCB_SHAPE::GetParentFootprint(), BOARD_ITEM::GetParentFootprint(), LIB_SYMBOL::GetPin(), SCH_SYMBOL::GetPinPhysicalPosition(), SCH_FIELD::GetPosition(), KIGFX::SCH_PAINTER::getRenderColor(), ALIGN_DISTRIBUTE_TOOL::GetSelections(), PCB_TRACK::GetSelectMenuText(), DRC_ENGINE::GetShape(), PCB_TEXT::GetShownText(), SCH_FIELD::GetShownText(), SCH_TEXT::GetShownText(), CONVERT_TOOL::getStartEndPoints(), getTopLevelGroup(), PCB_EXPR_TYPE_REF::GetValue(), GROUP_TOOL::Group(), PCB_SELECTION_TOOL::GuessSelectionCandidates(), hash_fp_item(), EE_SELECTION_TOOL::highlight(), PCB_SELECTION_TOOL::highlightInternal(), BOARD_INSPECTION_TOOL::HighlightItem(), BOARD_INSPECTION_TOOL::highlightNet(), highlightNet(), PCB_SELECTION_TOOL::hitTestDistance(), SCH_EDIT_TOOL::Init(), ROUTER_TOOL::InlineBreakTrack(), ROUTER_TOOL::InlineDrag(), EE_RTREE::insert(), DRC_RTREE::Insert(), insideArea(), insideBackCourtyard(), insideCourtyard(), insideFrontCourtyard(), EE_COLLECTOR::Inspect(), GENERAL_COLLECTOR::Inspect(), BOARD_INSPECTION_TOOL::InspectClearance(), BOARD_INSPECTION_TOOL::InspectConstraints(), BOARD_INSPECTION_TOOL::InspectDRCError(), ARRAY_CREATOR::Invoke(), isCopper(), CN_ANCHOR::IsDangling(), SCH_LINE_WIRE_BUS_TOOL::IsDrawingLineWireOrBus(), PNS_KICAD_IFACE::IsFlashedOnLayer(), CADSTAR_PCB_ARCHIVE_LOADER::isFootprint(), SCH_FIELD::IsHypertext(), isKeepoutZone(), DRC_ENGINE::IsNetTie(), PCB_TRACK::IsNull(), SCH_LINE::IsParallel(), isPlated(), SCH_FIELD::IsReplaceable(), PNS::ROUTER::isStartingPointRoutable(), BOARD_ITEM::IsTrack(), itemIsIncludedByFilter(), PCB_SELECTION_TOOL::itemPassesFilter(), CLIPBOARD_IO::Load(), FOOTPRINT_EDIT_FRAME::LoadFootprintFromBoard(), CADSTAR_SCH_ARCHIVE_LOADER::loadHierarchicalSheetPins(), CADSTAR_SCH_ARCHIVE_LOADER::loadNets(), SYMBOL_EDITOR_MOVE_TOOL::Main(), SCH_MOVE_TOOL::Main(), EE_SELECTION_TOOL::Main(), EDIT_POINTS_FACTORY::Make(), NETLIST_EXPORTER_XML::makeListOfNets(), PCB_POINT_EDITOR::makePoints(), CONVERT_TOOL::makePolysFromSegs(), MarkConnections(), CN_CONNECTIVITY_ALGO::markItemNetAsDirty(), CONNECTIVITY_DATA::MarkItemNetAsDirty(), SCH_FIELD::Matches(), memberOf(), SCH_LINE::MergeOverlap(), SCH_EDIT_TOOL::Mirror(), EDIT_TOOL::MoveExact(), SCH_MOVE_TOOL::moveItem(), SCH_EDITOR_CONTROL::nextMatch(), FOOTPRINT_EDIT_FRAME::OnEditItemRequest(), PCB_EDIT_FRAME::OnEditItemRequest(), EDA_3D_CANVAS::OnMouseMove(), PCB_POINT_EDITOR::OnSelectionChange(), PCB_SHAPE::cmp_drawings::operator()(), PCB_TRACK::cmp_tracks::operator()(), CN_VISITOR::operator()(), BOARD_ITEM::ptr_cmp::operator()(), FOOTPRINT::cmp_drawings::operator()(), BOARD::cmp_items::operator()(), BOARD::cmp_drawings::operator()(), SCH_BUS_ENTRY_BASE::operator<(), SCH_JUNCTION::operator<(), SCH_TEXT::operator<(), LIB_ITEM::operator<(), SCH_FIELD::operator<(), SCH_LINE::operator<(), SCH_SHEET::operator<(), SCH_ITEM::operator<(), SCH_SYMBOL::operator<(), SCH_BITMAP::operator=(), SCH_SHEET::operator=(), SCH_SYMBOL::operator=(), LIB_ITEM::operator==(), PAD::PAD(), EDIT_TOOL::PadFilter(), BOARD_COMMIT::parentObject(), PCB_CONTROL::Paste(), SCH_EDITOR_CONTROL::Paste(), DRAWING_TOOL::PlaceImportedGraphics(), SCH_FIELD::Plot(), Plot(), BRDITEMS_PLOTTER::PlotFootprintGraphicItem(), POSITION_RELATIVE_TOOL::PositionRelative(), SCH_FIELD::Print(), Print(), DIALOG_GLOBAL_EDIT_TRACKS_AND_VIAS::processItem(), BACK_ANNOTATE::processNetNameChange(), SYMBOL_EDITOR_EDIT_TOOL::Properties(), SCH_EDIT_TOOL::Properties(), BOARD_COMMIT::Push(), PCB_BASE_EDIT_FRAME::PutDataInPreviousState(), PCB_GRID_HELPER::queryVisible(), BOARD_REANNOTATE_TOOL::ReannotateDuplicates(), SCH_CONNECTION::recacheName(), SCH_BASE_FRAME::RefreshSelection(), KIGFX::PCB_VIEW::Remove(), EE_RTREE::remove(), FOOTPRINT::Remove(), CN_CONNECTIVITY_ALGO::Remove(), Remove(), BOARD::Remove(), PCB_POINT_EDITOR::removeCorner(), PCB_POINT_EDITOR::removeCornerCondition(), LIB_SYMBOL::RemoveDrawItem(), SCH_SHEET::RemovePin(), SCH_EDIT_TOOL::RepeatDrawItem(), SCH_FIELD::Replace(), SCH_EDITOR_CONTROL::ReplaceAll(), PCB_SELECTION_TOOL::RequestSelection(), SCHEMATIC::ResolveCrossReference(), PCB_PARSER::resolveGroups(), DS_PROXY_UNDO_ITEM::Restore(), PL_EDITOR_FRAME::RollbackFromUndo(), SCH_EDIT_TOOL::Rotate(), DRC_TEST_PROVIDER_MATCHED_LENGTH::runInternal(), PCB_BASE_EDIT_FRAME::SaveCopyInUndoList(), EE_TOOL_BASE< SCH_BASE_FRAME >::saveCopyInUndoList(), SCH_SEXPR_PLUGIN::saveField(), SCH_SEXPR_PLUGIN_CACHE::saveField(), SCH_LEGACY_PLUGIN_CACHE::saveField(), SCH_SEXPR_PLUGIN_CACHE::savePin(), SCH_LEGACY_PLUGIN_CACHE::savePin(), CLIPBOARD_IO::SaveSelection(), SCH_SEXPR_PLUGIN_CACHE::saveSymbolDrawItem(), SCH_SEXPR_PLUGIN::saveText(), SCH_SEXPR_PLUGIN_CACHE::saveText(), SCH_LEGACY_PLUGIN_CACHE::saveText(), Schematic(), SCH_ITEM::Schematic(), CONVERT_TOOL::SegmentToArc(), PCB_SELECTION_TOOL::select(), PCB_SELECTION_TOOL::Selectable(), EE_SELECTION_TOOL::Selectable(), PCB_SELECTION_TOOL::selectConnectedTracks(), PCB_POINT_EDITOR::setAltConstraint(), SCH_FIELD::SetId(), ITEM_PICKER::SetItem(), SCH_FIELD::SetPosition(), DIALOG_TEXT_AND_LABEL_PROPERTIES::SetTitle(), PCB_EDIT_FRAME::SetTrackSegmentWidth(), BOARD_COMMIT::Stage(), SCH_JUNCTION::SwapData(), SCH_NO_CONNECT::SwapData(), SCH_BITMAP::SwapData(), PCB_TARGET::SwapData(), SCH_SHEET_PIN::SwapData(), SCH_FIELD::SwapData(), PCB_GROUP::SwapData(), PCB_TEXT::SwapData(), PCB_TRACK::SwapData(), SCH_SHEET::SwapData(), PCB_ARC::SwapData(), PCB_DIM_ALIGNED::SwapData(), PCB_DIM_ORTHOGONAL::SwapData(), SCH_SYMBOL::SwapData(), PCB_VIA::SwapData(), PCB_DIM_LEADER::SwapData(), PCB_DIM_CENTER::SwapData(), PAD::SwapData(), FOOTPRINT::SwapData(), ZONE::SwapData(), SwapItemData(), DRC_TEST_PROVIDER_COPPER_CLEARANCE::testItemAgainstZones(), ERC_TESTER::TestMultUnitPinConflicts(), DRC_TEST_PROVIDER_COPPER_CLEARANCE::testPadAgainstItem(), ERC_TESTER::TestPinToPin(), ERC_TESTER::TestSimilarLabels(), DRC_TEST_PROVIDER_COPPER_CLEARANCE::testTrackAgainstItem(), CONNECTIVITY_DATA::TestTrackEndpointDangling(), DIALOG_TEXT_AND_LABEL_PROPERTIES::TransferDataFromWindow(), DIALOG_SYMBOL_FIELDS_TABLE::TransferDataToWindow(), DIALOG_DIMENSION_PROPERTIES::TransferDataToWindow(), DIALOG_TEXT_PROPERTIES::TransferDataToWindow(), DIALOG_TEXT_AND_LABEL_PROPERTIES::TransferDataToWindow(), PCB_TRACK::TransformShapeWithClearanceToPolygon(), SYMBOL_EDITOR_DRAWING_TOOLS::TwoClickPlace(), EE_SELECTION_TOOL::unhighlight(), PCB_SELECTION_TOOL::unhighlightInternal(), KIGFX::PCB_VIEW::Update(), SCH_TEXT::UpdateDanglingState(), DIALOG_DIMENSION_PROPERTIES::updateDimensionFromDialog(), DIALOG_SCH_FIELD_PROPERTIES::UpdateField(), PL_POINT_EDITOR::updateItem(), PCB_POINT_EDITOR::updateItem(), EE_TOOL_BASE< SCH_BASE_FRAME >::updateItem(), SCH_BASE_FRAME::UpdateItem(), CONNECTION_GRAPH::updateItemConnectivity(), SCH_EDITOR_CONTROL::UpdateNetHighlighting(), EE_POINT_EDITOR::updateParentItem(), SCH_EDITOR_CONTROL::updatePastedSheet(), EE_POINT_EDITOR::updatePoints(), PL_POINT_EDITOR::updatePoints(), PCB_POINT_EDITOR::updatePoints(), SCH_BUS_ENTRY_BASE::ViewGetLayers(), PCB_GROUP::Visit(), PCB_TRACK::Visit(), GERBER_DRAW_ITEM::Visit(), SCH_GLOBALLABEL::Visit(), SCH_SHEET::Visit(), DIALOG_GLOBAL_EDIT_TEXT_AND_GRAPHICS::visitItem(), and NETLIST_EXPORTER_CADSTAR::writeListOfNets().

Update()

void SCH_SCREEN::Update

(

SCH_ITEM *

aItem

)

Update aItem's bounding box in the tree.

Parameters

[in]

aItem

Item that needs to be updated.

Definition at line 266 of file sch_screen.cpp.

{
 if( Remove( aItem ) )
 Append( aItem );
}

References Append(), and Remove().

Referenced by CADSTAR_SCH_ARCHIVE_LOADER::Load(), SCH_EAGLE_PLUGIN::loadSheet(), SCH_DRAWING_TOOLS::PlaceSymbol(), SCH_EDIT_FRAME::RecomputeIntersheetRefs(), and SCH_BASE_FRAME::UpdateItem().

UpdateLocalLibSymbolLinks()

void SCH_SCREEN::UpdateLocalLibSymbolLinks

(

)

Initialize the LIB_SYMBOL reference for each SCH_SYMBOL found in this schematic with the local project library symbols.

Definition at line 764 of file sch_screen.cpp.

{
 std::vector<SCH_SYMBOL*> symbols;

 for( SCH_ITEM* item : Items().OfType( SCH_SYMBOL_T ) )
 symbols.push_back( static_cast<SCH_SYMBOL*>( item ) );

 for( SCH_SYMBOL* symbol : symbols )
 {
 // Changing the symbol may adjust the bbox of the symbol; remove and reinsert it afterwards.
 m_rtree.remove( symbol );

 auto it = m_libSymbols.find( symbol->GetSchSymbolLibraryName() );

 LIB_SYMBOL* libSymbol = nullptr;

 if( it != m_libSymbols.end() )
 libSymbol = new LIB_SYMBOL( *it->second );

 symbol->SetLibSymbol( libSymbol );

 m_rtree.insert( symbol );
 }
}

References EE_RTREE::insert(), Items(), m_libSymbols, m_rtree, EE_RTREE::remove(), and SCH_SYMBOL_T.

Referenced by SCH_SEXPR_PARSER::ParseSchematic().

UpdateSymbolLinks()

void SCH_SCREEN::UpdateSymbolLinks

(

REPORTER *

aReporter = nullptr

)

Initialize the LIB_SYMBOL reference for each SCH_SYMBOL found in this schematic from the project SYMBOL_LIB_TABLE.

Symbol library links are set using the symbol library table and will fall back to the cache only if the cache is loaded. The cache should only be loaded when opening legacy schematic files.

Note

This should only be called when the user specifically requests all library symbol links to be updated or when the legacy schematic is opened for the last time. All subsequent schematic loads with the new s-expression will contain the library symbols and should call UpdateLocalLibSymbolLinks.

Parameters

[in]

aReporter

Optional REPORTER object to write status and error messages into.

Definition at line 610 of file sch_screen.cpp.

{
 wxCHECK_RET( Schematic(), "Cannot call SCH_SCREEN::UpdateSymbolLinks with no SCHEMATIC" );

 wxString msg;
 std::unique_ptr< LIB_SYMBOL > libSymbol;
 std::vector<SCH_SYMBOL*> symbols;
 SYMBOL_LIB_TABLE* libs = Schematic()->Prj().SchSymbolLibTable();

 // This will be a nullptr if an s-expression schematic is loaded.
 SYMBOL_LIBS* legacyLibs = Schematic()->Prj().SchLibs();

 for( SCH_ITEM* item : Items().OfType( SCH_SYMBOL_T ) )
 symbols.push_back( static_cast<SCH_SYMBOL*>( item ) );

 // Remove them from the R tree. There bounding box size may change.
 for( SCH_SYMBOL* symbol : symbols )
 Remove( symbol );

 // Clear all existing symbol links.
 clearLibSymbols();

 for( SCH_SYMBOL* symbol : symbols )
 {
 LIB_SYMBOL* tmp = nullptr;
 libSymbol.reset();

 // If the symbol is already in the internal library, map the symbol to it.
 auto it = m_libSymbols.find( symbol->GetSchSymbolLibraryName() );

 if( ( it != m_libSymbols.end() ) )
 {
 if( aReporter )
 {
 msg.Printf( _( "Setting schematic symbol '%s %s' library identifier to '%s'." ),
 symbol->GetField( REFERENCE_FIELD )->GetText(),
 symbol->GetField( VALUE_FIELD )->GetText(),
 UnescapeString( symbol->GetLibId().Format() ) );
 aReporter->ReportTail( msg, RPT_SEVERITY_INFO );
 }

 // Internal library symbols are already flattened so just make a copy.
 symbol->SetLibSymbol( new LIB_SYMBOL( *it->second ) );
 continue;
 }

 if( !symbol->GetLibId().IsValid() )
 {
 if( aReporter )
 {
 msg.Printf( _( "Schematic symbol reference '%s' library identifier is not valid. "
 "Unable to link library symbol." ),
 UnescapeString( symbol->GetLibId().Format() ) );
 aReporter->ReportTail( msg, RPT_SEVERITY_WARNING );
 }

 continue;
 }

 // LIB_TABLE_BASE::LoadSymbol() throws an IO_ERROR if the library nickname
 // is not found in the table so check if the library still exists in the table
 // before attempting to load the symbol.
 if( !libs->HasLibrary( symbol->GetLibId().GetLibNickname() ) && !legacyLibs )
 {
 if( aReporter )
 {
 msg.Printf( _( "Symbol library '%s' not found and no fallback cache library "
 "available. Unable to link library symbol." ),
 symbol->GetLibId().GetLibNickname().wx_str() );
 aReporter->ReportTail( msg, RPT_SEVERITY_WARNING );
 }

 continue;
 }

 if( libs->HasLibrary( symbol->GetLibId().GetLibNickname() ) )
 {
 try
 {
 tmp = libs->LoadSymbol( symbol->GetLibId() );
 }
 catch( const IO_ERROR& ioe )
 {
 if( aReporter )
 {
  msg.Printf( _( "I/O error %s resolving library symbol %s" ), ioe.What(),
 UnescapeString( symbol->GetLibId().Format() ) );
 aReporter->ReportTail( msg, RPT_SEVERITY_ERROR );
 }
 }
 }

 if( !tmp && legacyLibs && legacyLibs->GetLibraryCount() )
 {
 SYMBOL_LIB& legacyCacheLib = legacyLibs->at( 0 );

 // It better be the cache library.
 wxCHECK2( legacyCacheLib.IsCache(), continue );

 wxString id = symbol->GetLibId().Format();

 id.Replace( ':', '_' );

 if( aReporter )
 {
 msg.Printf( _( "Falling back to cache to set symbol '%s:%s' link '%s'." ),
 symbol->GetField( REFERENCE_FIELD )->GetText(),
 symbol->GetField( VALUE_FIELD )->GetText(),
 UnescapeString( id ) );
 aReporter->ReportTail( msg, RPT_SEVERITY_WARNING );
 }

 tmp = legacyCacheLib.FindSymbol( id );
 }

 if( tmp )
 {
 // We want a full symbol not just the top level child symbol.
 libSymbol = tmp->Flatten();
 libSymbol->SetParent();

 m_libSymbols.insert( { symbol->GetSchSymbolLibraryName(),
 new LIB_SYMBOL( *libSymbol.get() ) } );

 if( aReporter )
 {
 msg.Printf( _( "Setting schematic symbol '%s %s' library identifier to '%s'." ),
 symbol->GetField( REFERENCE_FIELD )->GetText(),
 symbol->GetField( VALUE_FIELD )->GetText(),
 UnescapeString( symbol->GetLibId().Format() ) );
 aReporter->ReportTail( msg, RPT_SEVERITY_INFO );
 }
 }
 else
 {
 if( aReporter )
 {
 msg.Printf( _( "No library symbol found for schematic symbol '%s %s'." ),
 symbol->GetField( REFERENCE_FIELD )->GetText(),
 symbol->GetField( VALUE_FIELD )->GetText() );
 aReporter->ReportTail( msg, RPT_SEVERITY_ERROR );
 }
 }

 symbol->SetLibSymbol( libSymbol.release() );
 }

 // Changing the symbol may adjust the bbox of the symbol. This re-inserts the
 // item with the new bbox
 for( SCH_SYMBOL* symbol : symbols )
 Append( symbol );
}

References _, Append(), clearLibSymbols(), SYMBOL_LIB::FindSymbol(), LIB_SYMBOL::Flatten(), SYMBOL_LIBS::GetLibraryCount(), LIB_TABLE::HasLibrary(), SYMBOL_LIB::IsCache(), Items(), SYMBOL_LIB_TABLE::LoadSymbol(), m_libSymbols, SCHEMATIC::Prj(), REFERENCE_FIELD, Remove(), REPORTER::ReportTail(), RPT_SEVERITY_ERROR, RPT_SEVERITY_INFO, RPT_SEVERITY_WARNING, SCH_SYMBOL_T, Schematic(), UnescapeString(), VALUE_FIELD, and IO_ERROR::What().

ViewBBox()

const BOX2I EDA_ITEM::ViewBBox ( ) const

overridevirtualinherited

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

Returns

the current bounding box.

Implements KIGFX::VIEW_ITEM.

Reimplemented in PAD, FOOTPRINT, PCB_DIM_CENTER, EDIT_POINTS, PCB_DIMENSION_BASE, GERBER_DRAW_ITEM, FP_TEXT, PCB_TRACK, PCB_SHAPE, DS_PROXY_VIEW_ITEM, PCB_MARKER, ROUTER_PREVIEW_ITEM, MY_DRAWING, KIGFX::ORIGIN_VIEWITEM, KIGFX::PREVIEW::TWO_POINT_ASSISTANT, KIGFX::PREVIEW::CENTRELINE_RECT_ITEM, KIGFX::PREVIEW::SELECTION_AREA, KIGFX::PREVIEW::POLYGON_ITEM, KIGFX::PREVIEW::RULER_ITEM, RATSNEST_VIEW_ITEM, and KIGFX::PREVIEW::ARC_ASSISTANT.

Definition at line 257 of file eda_item.cpp.

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

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

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

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

ViewDraw()

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

inlinevirtualinherited

Draw the parts of the object belonging to layer aLayer.

An alternative way for drawing objects if there is no #PAINTER assigned for the view or if the PAINTER doesn't know how to paint this particular implementation of VIEW_ITEM. The preferred way of drawing is to design an appropriate PAINTER object, the method below is intended only for quick hacks and debugging purposes.

Parameters

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

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

Definition at line 106 of file view_item.h.

 {}

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

ViewGetLayers()

void 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 PAD, FOOTPRINT, EDIT_POINTS, PCB_VIA, SCH_SHEET, BOARD_ITEM, SCH_ITEM, GERBER_DRAW_ITEM, SCH_TEXT, FP_TEXT, PCB_TRACK, LIB_SYMBOL, MY_DRAWING, ZONE, PCB_GROUP, SCH_LINE, LIB_ITEM, SCH_SYMBOL, LIB_FIELD, DS_PROXY_VIEW_ITEM, PCB_MARKER, SCH_BITMAP, ROUTER_PREVIEW_ITEM, SCH_BUS_ENTRY_BASE, SCH_JUNCTION, SCH_PIN, SCH_NO_CONNECT, DS_DRAW_ITEM_BASE, KIGFX::PREVIEW::SIMPLE_OVERLAY_ITEM, KIGFX::ORIGIN_VIEWITEM, LIB_TEXT, KIGFX::PREVIEW::TWO_POINT_ASSISTANT, SCH_MARKER, RATSNEST_VIEW_ITEM, KIGFX::PREVIEW::RULER_ITEM, and KIGFX::PREVIEW::ARC_ASSISTANT.

Definition at line 266 of file eda_item.cpp.

{
 // Basic fallback
 aCount = 1;
 aLayers[0] = 0;
}

ViewGetLOD()

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

inlinevirtualinherited

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

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

Parameters

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

Returns

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

Reimplemented in FP_ZONE, PAD, FOOTPRINT, PCB_VIA, GERBER_DRAW_ITEM, FP_TEXT, PCB_TRACK, ZONE, PCB_GROUP, and FP_SHAPE.

Definition at line 132 of file view_item.h.

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

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

viewPrivData()

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

inlineinherited

Definition at line 138 of file view_item.h.

 {
 return m_viewPrivData;
 }

References KIGFX::VIEW_ITEM::m_viewPrivData.

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

Visit()

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

virtualinherited

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

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

Parameters

inspector	An INSPECTOR instance to use in the inspection.
testData	Arbitrary data used by the inspector.
scanTypes	Which# KICAD_T types are of interest and the order is significant too, terminated by EOT.

Returns

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

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

Definition at line 93 of file eda_item.cpp.

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

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

 return SEARCH_RESULT::CONTINUE;
}

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

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

Member Data Documentation

m_aliases

std::unordered_set< std::shared_ptr< BUS_ALIAS > > SCH_SCREEN::m_aliases

private

List of bus aliases stored in this screen.

Definition at line 552 of file sch_screen.h.

Referenced by AddBusAlias(), ClearBusAliases(), and GetBusAliases().

m_aux_origin

wxPoint SCH_SCREEN::m_aux_origin

private

Definition at line 537 of file sch_screen.h.

Referenced by GetAuxOrigin(), and SetAuxOrigin().

m_Center

bool BASE_SCREEN::m_Center

inherited

Center on screen.

If true (0.0) is centered on screen coordinates can be < 0 and > 0 except for schematics. false: when coordinates can only be >= 0 (schematics).

Definition at line 96 of file base_screen.h.

Referenced by BASE_SCREEN::BASE_SCREEN(), FOOTPRINT_VIEWER_FRAME::FOOTPRINT_VIEWER_FRAME(), BASE_SCREEN::InitDataPoints(), SCH_SCREEN(), and SYMBOL_VIEWER_FRAME::SYMBOL_VIEWER_FRAME().

m_clientSheetPathList

std::vector<SCH_SHEET_PATH> SCH_SCREEN::m_clientSheetPathList

private

The list of sheet paths sharing this screen.

Used in some annotation calculations to update alternate references.

Note: a screen having a m_refCount = 1 (only one sheet path using it) can have many sheet paths sharing this screen if it is inside another sheet having many instances.

Definition at line 532 of file sch_screen.h.

Referenced by GetClientSheetPaths().

m_DrawingSheetFileName

wxString BASE_SCREEN::m_DrawingSheetFileName

staticinherited

the name of the drawing sheet file, or empty to use the default drawing sheet

Definition at line 85 of file base_screen.h.

Referenced by PL_EDITOR_FRAME::GetCurrentFileName(), SCH_EDIT_FRAME::importFile(), SCH_EDIT_FRAME::LoadProjectSettings(), PCB_EDIT_FRAME::LoadProjectSettings(), BOARD_EDITOR_CONTROL::PageSettings(), SCH_EDITOR_CONTROL::PageSetup(), DIALOG_PAGES_SETTINGS::SavePageSettings(), PCB_EDIT_FRAME::SaveProjectSettings(), SCHEMATIC_SETTINGS::SCHEMATIC_SETTINGS(), PL_EDITOR_FRAME::SetCurrentFileName(), and DIALOG_PAGES_SETTINGS::TransferDataToWindow().

m_DrawOrg

wxPoint BASE_SCREEN::m_DrawOrg

inherited

offsets for drawing the circuit on the screen

Definition at line 88 of file base_screen.h.

Referenced by SCH_EDIT_FRAME::DrawCurrentSheetToClipboard(), BASE_SCREEN::InitDataPoints(), PLEDITOR_PRINTOUT::PrintPage(), and SCH_PRINTOUT::PrintPage().

m_fileExists

bool SCH_SCREEN::m_fileExists

private

Definition at line 549 of file sch_screen.h.

Referenced by FileExists(), and SetFileExists().

m_fileFormatVersionAtLoad

int SCH_SCREEN::m_fileFormatVersionAtLoad

private

Definition at line 522 of file sch_screen.h.

Referenced by GetFileFormatVersionAtLoad(), and SetFileFormatVersionAtLoad().

m_fileName

wxString SCH_SCREEN::m_fileName

private

Definition at line 521 of file sch_screen.h.

Referenced by GetFileName(), and SetFileName().

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_SHAPE::HitTest(), LIB_TEXT::HitTest(), SCH_JUNCTION::HitTest(), LIB_PIN::HitTest(), LIB_ITEM::HitTest(), SCH_LINE::HitTest(), SCH_SYMBOL::HitTest(), ZONE::InitDataFromSrcInCopyCtor(), EDA_ITEM::IsBrightened(), SCH_ITEM::IsConnected(), EDA_ITEM::IsDragging(), EDA_ITEM::IsEntered(), EDA_ITEM::IsModified(), EDA_ITEM::IsMoving(), EDA_ITEM::IsNew(), EDA_ITEM::IsResized(), EDA_ITEM::IsSelected(), EDA_ITEM::IsWireImage(), SCH_LINE::MirrorHorizontally(), SCH_LINE::MirrorVertically(), EDA_ITEM::operator=(), SCH_LINE::Rotate(), EDA_ITEM::SetFlags(), and PCB_SHAPE::SwapData().

m_forceVisible

bool EDA_ITEM::m_forceVisible

protectedinherited

Definition at line 479 of file eda_item.h.

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

m_isReadOnly

bool SCH_SCREEN::m_isReadOnly

private

Read only status of the screen file.

Flag to indicate the file associated with this screen has been created.

Definition at line 546 of file sch_screen.h.

Referenced by IsReadOnly(), and SetFileReadOnly().

m_LastZoomLevel

double SCH_SCREEN::m_LastZoomLevel

last value for the zoom level, useful in Eeschema when changing the current displayed sheet to reuse the same zoom level when back to the sheet using this screen

Definition at line 508 of file sch_screen.h.

Referenced by SCH_EDITOR_CONTROL::EnterSheet(), SCH_EDITOR_CONTROL::LeaveSheet(), SCH_EDIT_FRAME::OnPageSettingsChange(), HIERARCHY_NAVIG_DLG::onSelectSheetPath(), and SCH_SCREEN().

m_libSymbols

std::map<wxString, LIB_SYMBOL*> SCH_SCREEN::m_libSymbols

private

Library symbols required for this schematic.

Definition at line 555 of file sch_screen.h.

Referenced by AddLibSymbol(), Append(), clearLibSymbols(), GetLibSymbols(), Remove(), UpdateLocalLibSymbolLinks(), and UpdateSymbolLinks().

m_LocalOrigin

VECTOR2D BASE_SCREEN::m_LocalOrigin

inherited

Relative Screen cursor coordinate (on grid) in user units.

(coordinates from last reset position)

Definition at line 90 of file base_screen.h.

Referenced by DRAWING_TOOL::drawSegment(), BASE_SCREEN::InitDataPoints(), DIALOG_POSITION_RELATIVE::OnUseUserOriginClick(), COMMON_TOOLS::ResetLocalCoords(), GERBVIEW_FRAME::UpdateStatusBar(), PL_EDITOR_FRAME::UpdateStatusBar(), SCH_BASE_FRAME::UpdateStatusBar(), and PCB_BASE_FRAME::UpdateStatusBar().

m_modification_sync

int SCH_SCREEN::m_modification_sync

private

Definition at line 540 of file sch_screen.h.

Referenced by Append(), and SCH_SCREEN().

m_pageCount

int BASE_SCREEN::m_pageCount

protectedinherited

The number of BASE_SCREEN objects in this design.

This currently only has meaning for SCH_SCREEN objects because PCB_SCREEN object are limited to a single file. The count is virtual because SCH_SCREEN objects can be used more than once so the screen (page) count can be more than the number of screen objects.

Definition at line 111 of file base_screen.h.

Referenced by BASE_SCREEN::BASE_SCREEN(), Clear(), BASE_SCREEN::GetPageCount(), and BASE_SCREEN::SetPageCount().

m_pageNumber

wxString BASE_SCREEN::m_pageNumber

protectedinherited

A user defined string page number used for printing and plotting.

This currently only has meaning for SCH_SCREEN objects because PCB_SCREEN object are limited to a single file. This must be set before displaying, printing, or plotting the current sheet. If empty, the m_virtualPageNumber value is converted to a string.

Definition at line 129 of file base_screen.h.

Referenced by BASE_SCREEN::GetPageNumber(), and BASE_SCREEN::SetPageNumber().

m_paper

PAGE_INFO SCH_SCREEN::m_paper

private

Definition at line 535 of file sch_screen.h.

Referenced by GetPageSettings(), SCH_SCREEN(), and SetPageSettings().

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_FIELD::Copy(), SCH_FIELD::DoHypertextMenu(), FP_TEXT::FP_TEXT(), SCH_FIELD::GetBoundingBox(), SCH_FIELD::GetCanonicalName(), SCH_TEXT::GetContextualTextVars(), SCH_FIELD::GetDrawRotation(), FP_TEXT::GetDrawRotation(), SCH_FIELD::GetMenuImage(), FP_SHAPE::GetMsgPanelInfo(), FP_TEXT::GetMsgPanelInfo(), PCB_DIMENSION_BASE::GetMsgPanelInfo(), PAD::GetMsgPanelInfo(), SCH_FIELD::GetName(), PAD::GetParent(), EDA_ITEM::GetParent(), BOARD_ITEM::GetParent(), SCH_SHEET_PIN::GetParent(), LIB_ITEM::GetParent(), FP_TEXT::GetParentAsString(), PAD::GetParentAsString(), FP_SHAPE::GetParentAsString(), PCB_SHAPE::GetParentFootprint(), SCH_FIELD::GetParentPosition(), SCH_FIELD::GetPosition(), SCH_FIELD::GetShownText(), SCH_TEXT::GetShownText(), LIB_FIELD::HitTest(), SCH_FIELD::IsHypertext(), SCH_FIELD::IsReplaceable(), SCH_FIELD::Matches(), LIB_FIELD::operator=(), EDA_ITEM::operator=(), PAD::PAD(), SCH_FIELD::Plot(), SCH_FIELD::Print(), SCH_FIELD::Replace(), SCH_SYMBOL::SCH_SYMBOL(), FP_SHAPE::SetDrawCoord(), FP_TEXT::SetDrawCoord(), PAD::SetDrawCoord(), SCH_FIELD::SetId(), FP_SHAPE::SetLocalCoord(), FP_TEXT::SetLocalCoord(), PAD::SetLocalCoord(), EDA_ITEM::SetModified(), EDA_ITEM::SetParent(), SCH_FIELD::SetPosition(), PCB_SHAPE::SwapData(), and FP_TEXT::TransformShapeWithClearanceToPolygon().

m_refCount

int SCH_SCREEN::m_refCount

private

Definition at line 523 of file sch_screen.h.

Referenced by DecRefCount(), GetRefCount(), IncRefCount(), and SCH_SCREEN().

m_rtree

EE_RTREE SCH_SCREEN::m_rtree

private

Definition at line 538 of file sch_screen.h.

Referenced by Append(), CheckIfOnDrawList(), Clear(), FreeDrawList(), HasItems(), IsEmpty(), Items(), Remove(), and UpdateLocalLibSymbolLinks().

m_ScrollCenter

VECTOR2D BASE_SCREEN::m_ScrollCenter

inherited

Current scroll center point in logical units.

Definition at line 100 of file base_screen.h.

Referenced by EDA_DRAW_PANEL_GAL::DoRePaint(), and DIALOG_ERC::OnERCItemSelected().

m_sheetInstances

std::vector<SCH_SHEET_INSTANCE> SCH_SCREEN::m_sheetInstances

private

Definition at line 572 of file sch_screen.h.

Referenced by SCH_SEXPR_PLUGIN::Format(), GetSheetInstances(), and SCH_SEXPR_PARSER::parseSchSheetInstances().

m_StartVisu

wxPoint BASE_SCREEN::m_StartVisu

inherited

Coordinates in drawing units of the current view position (upper left corner of device)

Definition at line 93 of file base_screen.h.

Referenced by SCH_EDIT_FRAME::DrawCurrentSheetToClipboard(), PLEDITOR_PRINTOUT::PrintPage(), SCH_PRINTOUT::PrintPage(), and DIALOG_FIND::search().

m_status

EDA_ITEM_FLAGS EDA_ITEM::m_status

protectedinherited

Definition at line 477 of file eda_item.h.

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

m_symbolInstances

std::vector<SYMBOL_INSTANCE_REFERENCE> SCH_SCREEN::m_symbolInstances

private

The list of symbol instances loaded from the schematic file.

This list is only used to as temporary storage when the schematic file is loaded. If the screen is the root sheet, then this information is used to update the SCH_SYMBOL instance reference and unit information after the entire schematic is loaded and is never used again. If this screen is not the root sheet, then the schematic file is the root sheet of another project and this information is saved unchanged back to the schematic file.

Warning

Under no circumstances is this information to be modified or used after the schematic file is loaded. It is read only and it is only written to non-root schematic files.

Definition at line 571 of file sch_screen.h.

Referenced by SCH_SEXPR_PLUGIN::Format(), GetSymbolInstances(), and SCH_SEXPR_PARSER::parseSchSymbolInstances().

m_titles

TITLE_BLOCK SCH_SCREEN::m_titles

private

Definition at line 536 of file sch_screen.h.

Referenced by Clear(), GetTitleBlock(), and SetTitleBlock().

m_Uuid

const KIID EDA_ITEM::m_Uuid

inherited

Definition at line 474 of file eda_item.h.

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

m_uuid

KIID SCH_SCREEN::m_uuid

private

A unique identifier for each schematic file.

As of right now, this only has meaning for the root schematic. In the future, it may be useful to detect unexpected hierarchy changes.

Definition at line 580 of file sch_screen.h.

Referenced by AssignNewUuid(), SCH_SEXPR_PLUGIN::Format(), GetUuid(), and SCH_SEXPR_PARSER::ParseSchematic().

m_virtualPageNumber

int BASE_SCREEN::m_virtualPageNumber

protectedinherited

An integer based page number used for printing a range of pages.

This page number is set before printing and plotting because page numbering does not reflect the actual page number in complex hiearachies in SCH_SCREEN objects.

Definition at line 119 of file base_screen.h.

Referenced by BASE_SCREEN::BASE_SCREEN(), Clear(), BASE_SCREEN::GetPageNumber(), BASE_SCREEN::GetVirtualPageNumber(), and BASE_SCREEN::SetVirtualPageNumber().

m_zoomInitialized

bool SCH_SCREEN::m_zoomInitialized

private

Definition at line 543 of file sch_screen.h.

Referenced by SCH_EDIT_FRAME::DisplayCurrentSheet(), SCH_EDIT_FRAME::initScreenZoom(), and SCH_SCREEN().

SCH_EDIT_FRAME

friend SCH_SCREEN::SCH_EDIT_FRAME

private

Definition at line 515 of file sch_screen.h.

SCH_SEXPR_PARSER

friend SCH_SCREEN::SCH_SEXPR_PARSER

private

Definition at line 516 of file sch_screen.h.

SCH_SEXPR_PLUGIN

friend SCH_SCREEN::SCH_SEXPR_PLUGIN

private

Definition at line 517 of file sch_screen.h.

---

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

• sch_screen.h
• sch_screen.cpp