SCH_SCREEN Class Reference

#include <sch_screen.h>

Inheritance diagram for SCH_SCREEN:

Public Member Functions
	SCH_SCREEN (EDA_ITEM *aParent=nullptr)
	Constructor. More...
	~SCH_SCREEN ()
SCHEMATIC *	Schematic () const
EE_RTREE &	Items ()
const EE_RTREE &	Items () const
bool	IsEmpty ()
bool	HasItems (KICAD_T aItemType) const
bool	HasSheets () const
virtual wxString	GetClass () const override
	Return the class name. More...
const PAGE_INFO &	GetPageSettings () const
void	SetPageSettings (const PAGE_INFO &aPageSettings)
void	SetFileName (const wxString &aFileName)
const wxString &	GetFileName () 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
std::vector< SCH_SHEET_PATH > &	GetClientSheetPaths ()
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)
	Check aPosition within a distance of aAccuracy for items of type aFilter. More...
void	Place (SCH_EDIT_FRAME *frame, wxDC *DC)
void	UpdateSymbolLinks (REPORTER *aReporter=nullptr)
	Initialize the LIB_PART reference for each SCH_COMPONENT found in this schematic from the project SYMBOL_LIB_TABLE. More...
void	UpdateLocalLibSymbolLinks ()
	Initialize the LIB_PART reference for each SCH_COMPONENT found in this schematic with the local project library symbols. More...
void	Print (RENDER_SETTINGS *aSettings)
	Print all the items in the screen to aDC. More...
void	Plot (PLOTTER *aPlotter)
	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)
	Updates 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 (SCH_ITEM *st)
bool	TestDanglingEnds (const SCH_SHEET_PATH *aPath=nullptr)
	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 component pin. More...
void	ClearDrawingState ()
	Clear the state flags of all the items in the screen. More...
size_t	CountConnectedItems (const wxPoint &aPos, bool aTestJunctions)
bool	IsJunctionNeeded (const wxPoint &aPosition, bool aNew=false)
	Test if a junction is required for the items at aPosition on the screen. More...
bool	IsTerminalPoint (const wxPoint &aPosition, int aLayer)
	Test if aPosition is a connection point on aLayer. More...
LIB_PIN *	GetPin (const wxPoint &aPosition, SCH_COMPONENT **aSymbol=NULL, bool aEndPointOnly=false)
	Test the screen for a component pin item at aPosition. More...
SCH_SHEET_PIN *	GetSheetLabel (const wxPoint &aPosition)
	Test the screen if aPosition is a sheet label object. More...
void	ClearAnnotation (SCH_SHEET_PATH *aSheetPath)
	Clear the annotation for the components 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)
	Add all schematic sheet and component objects in the screen to aItems. More...
void	GetSheets (std::vector< SCH_ITEM * > *aItems)
	Similar to GetItems().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)
	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)
SCH_LINE *	GetBus (const wxPoint &aPosition, int aAccuracy=0, SCH_LINE_TEST_T aSearchType=ENTIRE_LENGTH_T)
SCH_TEXT *	GetLabel (const wxPoint &aPosition, int aAccuracy=0)
	Return a label item located at aPosition. More...
std::map< wxString, LIB_PART * > &	GetLibSymbols ()
	Fetch a list of unique LIB_PART object pointers required to properly render each SCH_COMPONENT in this schematic. More...
void	AddLibSymbol (LIB_PART *aLibSymbol)
	Add aLibSymbol to the the library symbol map. More...
void	AddBusAlias (std::shared_ptr< BUS_ALIAS > aAlias)
	Adds a bus alias definition (and transfers ownership of the pointer) More...
void	ClearBusAliases ()
	Removes all bus alias definitions. More...
std::unordered_set< std::shared_ptr< BUS_ALIAS > >	GetBusAliases ()
	Returns 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
void	InitDataPoints (const wxSize &aPageSizeInternalUnits)
void	SetModify ()
void	ClrModify ()
void	SetSave ()
void	ClrSave ()
bool	IsModify () const
bool	IsSave () 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
	Function Type() 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	IsResized () const
bool	IsBrightened () const
void	SetWireImage ()
void	SetSelected ()
void	SetBrightened ()
void	ClearSelected ()
void	ClearBrightened ()
void	SetModified ()
int	GetState (int type) const
void	SetState (int type, int state)
STATUS_FLAGS	GetStatus () const
void	SetStatus (STATUS_FLAGS aStatus)
void	SetFlags (STATUS_FLAGS aMask)
void	ClearFlags (STATUS_FLAGS aMask=EDA_ITEM_ALL_FLAGS)
STATUS_FLAGS	GetFlags () const
bool	HasFlag (STATUS_FLAGS aFlag)
STATUS_FLAGS	GetEditFlags () const
void	ClearTempFlags ()
void	ClearEditFlags ()
virtual bool	IsType (const KICAD_T aScanTypes[]) const
	Function IsType Checks whether the item is one of the listed types. More...
void	SetForceVisible (bool aEnable)
	Function SetForceVisible is used to set and cleag 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)
	Function GetMsgPanelInfo populates 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
	Function HitTest tests if aPosition is contained within or on the bounding box of an item. More...
virtual bool	HitTest (const EDA_RECT &aRect, bool aContained, int aAccuracy=0) const
	Function HitTest tests if aRect intersects or is contained within the bounding box of an item. More...
virtual const EDA_RECT	GetBoundingBox () const
	Function GetBoundingBox returns 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
	Function GetFocusPosition similar to GetPosition, but allows items to return their visual center rather than their anchor. More...
virtual EDA_ITEM *	Clone () const
	Function Clone creates 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[])
	Function Visit 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
	Function GetSelectMenuText returns 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 BITMAP_DEF	GetMenuImage () const
	Function GetMenuImage returns a pointer to an image to be used in menus. More...
virtual bool	Matches (wxFindReplaceData &aSearchData, void *aAuxData)
	Function Matches compares the item against the search criteria in aSearchData. More...
virtual bool	Replace (wxFindReplaceData &aSearchData, void *aAuxData=NULL)
	Function Replace performs a text replace using the find and replace criteria in aSearchData on items that support text find and replace. More...
virtual bool	IsReplaceable () const
	Function IsReplaceable. More...
bool	operator< (const EDA_ITEM &aItem) const
	Test if another item is less than this object. More...
virtual const BOX2I	ViewBBox () const override
	Function ViewBBox() returns the bounding box of the item covering all its layers. More...
virtual void	ViewGetLayers (int aLayers[], int &aCount) const override
	Function ViewGetLayers() Returns the all the layers within the VIEW the object is painted on. More...
virtual void	ViewDraw (int aLayer, VIEW *aView) const
	Function ViewDraw() Draws the parts of the object belonging to layer aLayer. More...
virtual double	ViewGetLOD (int aLayer, VIEW *aView) const
	Function ViewGetLOD() Returns 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[])
	IterateForward( EDA_ITEM*, INSPECTOR, void*, const KICAD_T ) More...
template<class T >
static SEARCH_RESULT	IterateForward (std::vector< T > &aList, INSPECTOR inspector, void *testData, const KICAD_T scanTypes[])
	IterateForward( EDA_ITEM*, INSPECTOR, void*, const KICAD_T ) More...
static bool	Replace (wxFindReplaceData &aSearchData, wxString &aText)
	Helper function used in search and replace dialog Function Replace performs 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)
	Function Sort is a helper function to be used by the C++ STL sort algorithm for sorting a STL container of EDA_ITEM pointers. More...

Public Attributes
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...
bool	m_Initialized
const KIID	m_Uuid

Static Public Attributes
static wxString	m_PageLayoutDescrFileName
	the name of the page layout descr file, or emty to used the default pagelayout More...

Protected Member Functions
bool	Matches (const wxString &aText, wxFindReplaceData &aSearchData)
	Function Matches compares 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...
STATUS_FLAGS	m_status
EDA_ITEM *	m_parent
	Linked list: Link (parent struct) More...
bool	m_forceVisible
STATUS_FLAGS	m_flags

Private Member Functions
void	clearLibSymbols ()

Private Attributes
wxString	m_fileName
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
std::unordered_set< std::shared_ptr< BUS_ALIAS > >	m_aliases
	List of bus aliases stored in this screen. More...
std::map< wxString, LIB_PART * >	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
friend	SCH_EDIT_FRAME
friend	SCH_SEXPR_PARSER
friend	SCH_SEXPR_PLUGIN

Detailed Description

Definition at line 93 of file sch_screen.h.

Constructor & Destructor Documentation

SCH_SCREEN()

SCH_SCREEN::SCH_SCREEN

(

EDA_ITEM *

aParent = nullptr

)

Constructor.

Definition at line 67 of file sch_screen.cpp.

                                          :
    BASE_SCREEN( aParent, SCH_SCREEN_T ),
    m_paper( wxT( "A4" ) )
{
    m_modification_sync = 0;

    m_refCount = 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_modification_sync, m_paper, and m_refCount.

~SCH_SCREEN()

SCH_SCREEN::~SCH_SCREEN

(

)

Definition at line 82 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

)

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

Definition at line 1100 of file sch_screen.cpp.

{
    m_aliases.insert( aAlias );
}

References m_aliases.

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

AddLibSymbol()

void SCH_SCREEN::AddLibSymbol

(

LIB_PART *

aLibSymbol

)

Add aLibSymbol to the 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_PART to be added to the symbol map.

Definition at line 1082 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_PART::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 129 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_COMPONENT_T )
        {
            SCH_COMPONENT* symbol = static_cast<SCH_COMPONENT*>( aItem );

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

                if( it == m_libSymbols.end() )
                {
                    m_libSymbols[symbol->GetSchSymbolLibraryName()] =
                            new LIB_PART( *symbol->GetPartRef() );
                }
                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_PART* foundSymbol = it->second;

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

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

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

                        symbol->SetSchSymbolLibraryName( newName );
                        m_libSymbols[newName] = new LIB_PART( *symbol->GetPartRef() );
                    }
                }
            }
        }

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

References LIB_ID::Format(), SCH_COMPONENT::GetLibId(), SCH_COMPONENT::GetPartRef(), SCH_COMPONENT::GetSchSymbolLibraryName(), EE_RTREE::insert(), m_libSymbols, m_modification_sync, m_rtree, SCH_COMPONENT_T, SCH_FIELD_T, SCH_SHEET_PIN_T, EDA_ITEM::SetParent(), SCH_COMPONENT::SetSchSymbolLibraryName(), EDA_ITEM::Type(), and UTF8::wx_str().

Referenced by SCH_EAGLE_PLUGIN::addImplicitConnections(), Append(), CONNECTION_GRAPH::ercCheckFloatingWires(), CONNECTION_GRAPH::ercCheckLabels(), CONNECTION_GRAPH::ercCheckNoConnects(), SCH_LEGACY_PLUGIN::LoadContent(), CADSTAR_SCH_ARCHIVE_LOADER::loadHierarchicalSheetPins(), SCH_EAGLE_PLUGIN::loadInstance(), CADSTAR_SCH_ARCHIVE_LOADER::loadSchematicSymbol(), SCH_EAGLE_PLUGIN::loadSegments(), CADSTAR_SCH_ARCHIVE_LOADER::loadSheetAndChildSheets(), SCH_EDIT_FRAME::LoadSheetFromFile(), DIALOG_SHEET_PROPERTIES::onSheetFilenameChanged(), SCH_ALTIUM_PLUGIN::ParseBezier(), SCH_ALTIUM_PLUGIN::ParseBus(), SCH_ALTIUM_PLUGIN::ParseBusEntry(), SCH_ALTIUM_PLUGIN::ParseComponent(), 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::ParsePowerPort(), SCH_ALTIUM_PLUGIN::ParseRectangle(), SCH_ALTIUM_PLUGIN::ParseRoundRectangle(), SCH_SEXPR_PARSER::ParseSchematic(), SCH_ALTIUM_PLUGIN::ParseSheetSymbol(), SCH_ALTIUM_PLUGIN::ParseWire(), SCH_EDITOR_CONTROL::Paste(), DIALOG_CHANGE_SYMBOLS::processSymbol(), CONNECTION_SUBGRAPH::ResolveDrivers(), SCH_EDIT_FRAME::ResolveERCExclusions(), ERC_TESTER::TestDuplicateSheetNames(), ERC_TESTER::TestMultiunitFootprints(), ERC_TESTER::TestMultUnitPinConflicts(), ERC_TESTER::TestSimilarLabels(), ERC_TESTER::TestTextVars(), DIALOG_SYMBOL_PROPERTIES::TransferDataFromWindow(), Update(), SCH_EDIT_FRAME::UpdateSymbolFromEditor(), 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 183 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 it's
    // children are copied as well.
    for( auto aItem : aScreen->m_rtree )
        Append( aItem );

    aScreen->Clear( false );
}

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

CheckIfOnDrawList()

bool SCH_SCREEN::CheckIfOnDrawList

(

SCH_ITEM *

st

)

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

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

inlinestatic

Definition at line 171 of file sch_screen.h.

    {
        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 196 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 components in aSheetPath on the screen.

Parameters

aSheetPath

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

Definition at line 922 of file sch_screen.cpp.

{

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

        symbol->ClearAnnotation( aSheetPath );
    }
}

References SCH_COMPONENT::ClearAnnotation(), Items(), and SCH_COMPONENT_T.

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

ClearBrightened()

void EDA_ITEM::ClearBrightened ( )

inlineinherited

Definition at line 200 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(), SELECTION_TOOL::unhighlightInternal(), and SCH_EDITOR_CONTROL::UpdateNetHighlighting().

ClearBusAliases()

void SCH_SCREEN::ClearBusAliases ( )

inline

Removes all bus alias definitions.

Definition at line 483 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 832 of file sch_screen.cpp.

{
    for( auto 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 239 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(), LIB_DRAWING_TOOLS::DrawShape(), SCH_LINE_WIRE_BUS_TOOL::finishSegments(), PL_DRAWING_TOOLS::PlaceItem(), SCH_EDIT_FRAME::PutDataInPreviousState(), PCB_BASE_EDIT_FRAME::SaveCopyInUndoList(), and LIB_DRAWING_TOOLS::TwoClickPlace().

ClearFlags()

void EDA_ITEM::ClearFlags ( STATUS_FLAGS  aMask = EDA_ITEM_ALL_FLAGS )

inlineinherited

Definition at line 221 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(), LIB_EDIT_TOOL::Copy(), FOOTPRINT_EDITOR_TOOLS::CreateFootprint(), LIB_PIN_TOOL::CreateImagePins(), MICROWAVE_TOOL::createMicrowaveInductor(), DIALOG_PAD_PROPERTIES::DIALOG_PAD_PROPERTIES(), KIGFX::SCH_PAINTER::draw(), LIB_EDIT_TOOL::Duplicate(), SCH_ITEM::Duplicate(), PCB_EDIT_FRAME::ExchangeFootprint(), SYMBOL_EDIT_FRAME::GetSymbolFromRedoList(), SYMBOL_EDIT_FRAME::GetSymbolFromUndoList(), FOOTPRINT_EDITOR_TOOLS::ImportFootprint(), FOOTPRINT_EDIT_FRAME::LoadFootprintFromBoard(), FOOTPRINT_EDIT_FRAME::LoadFootprintFromLibrary(), EE_SELECTION_TOOL::Main(), EE_SELECTION_TOOL::narrowSelection(), FOOTPRINT_EDITOR_TOOLS::NewFootprint(), FOOTPRINT_EDIT_FRAME::OpenProjectFiles(), PCB_BASE_FRAME::PlaceFootprint(), LIB_PIN_TOOL::PlacePin(), DRAWING_TOOL::PlaceText(), BOARD_COMMIT::Push(), SCH_EDIT_TOOL::RepeatDrawItem(), LIB_PIN_TOOL::RepeatPin(), SYMBOL_EDIT_FRAME::RollbackSymbolFromUndo(), SCH_EDIT_FRAME::SaveCopyForRepeatItem(), FOOTPRINT_EDIT_FRAME::SaveFootprintToBoard(), SCH_SEXPR_PLUGIN_CACHE::savePin(), SCH_LEGACY_PLUGIN_CACHE::savePin(), 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 98 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 199 of file eda_item.h.

{ ClearFlags( SELECTED ); }

References EDA_ITEM::ClearFlags(), and SELECTED.

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

ClearTempFlags()

void EDA_ITEM::ClearTempFlags ( )

inlineinherited

Definition at line 233 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 154 of file view_item.h.

    {
        m_viewPrivData = NULL;
    }

References KIGFX::VIEW_ITEM::m_viewPrivData, and NULL.

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

Clone()

EDA_ITEM * EDA_ITEM::Clone ( ) const

virtualinherited

Function Clone creates 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_COMPONENT, PAD, FOOTPRINT, SCH_SHEET, CENTER_DIMENSION, SCH_HIERLABEL, LEADER, VIA, ORTHOGONAL_DIMENSION, SCH_GLOBALLABEL, SCH_LABEL, ALIGNED_DIMENSION, ARC, PCB_SHAPE, SCH_TEXT, LIB_PIN, SCH_LINE, TRACK, FP_TEXT, SCH_SHEET_PIN, SCH_BUS_BUS_ENTRY, SCH_FIELD, LIB_FIELD, SCH_BUS_WIRE_ENTRY, SCH_BITMAP, FP_SHAPE, LIB_ARC, PCB_TEXT, PCB_GROUP, SCH_JUNCTION, SCH_NO_CONNECT, LIB_POLYLINE, SCH_MARKER, LIB_TEXT, PCB_TARGET, LIB_CIRCLE, LIB_BEZIER, LIB_RECTANGLE, and KIGFX::ORIGIN_VIEWITEM.

Definition at line 97 of file eda_item.cpp.

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

References EDA_ITEM::GetClass(), and NULL.

Referenced by DIALOG_DIMENSION_PROPERTIES::DIALOG_DIMENSION_PROPERTIES(), LIB_DRAWING_TOOLS::DrawShape(), LIB_EDIT_TOOL::Duplicate(), BOARD_ITEM::Duplicate(), SCH_ITEM::Duplicate(), DIMENSION_BASE::GetEffectiveShape(), LIB_PART::LIB_PART(), SYMBOL_EDIT_FRAME::LoadOneSymbol(), new_clone(), LIB_PART::operator=(), LIB_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_PART::SetConversion(), LIB_PART::SetUnitCount(), SCH_DRAWING_TOOLS::SingleClickPlace(), COMMIT::Stage(), LIB_DRAWING_TOOLS::TwoClickPlace(), and SCH_DRAWING_TOOLS::TwoClickPlace().

ClrModify()

void BASE_SCREEN::ClrModify ( )

inlineinherited

Definition at line 121 of file base_screen.h.

{ m_flagModified = false; }

References BASE_SCREEN::m_flagModified.

Referenced by FOOTPRINT_EDIT_FRAME::Clear_Pcb(), PCB_EDIT_FRAME::Clear_Pcb(), SYMBOL_LIBRARY_MANAGER::ClearLibraryModified(), FOOTPRINT_EDIT_FRAME::ClearModify(), SCH_SHEET_LIST::ClearModifyStatus(), PCB_EDIT_FRAME::ExportSpecctraFile(), PCB_EDIT_FRAME::Files_io_from_id(), PL_EDITOR_FRAME::LoadPageLayoutDescrFile(), PL_EDITOR_FRAME::OnNewPageLayout(), PCB_EDIT_FRAME::OpenProjectFiles(), FOOTPRINT_EDIT_FRAME::RevertFootprint(), SCH_EDIT_FRAME::SaveEEFile(), PL_EDITOR_FRAME::SavePageLayoutDescrFile(), PCB_EDIT_FRAME::SavePcbFile(), and LIB_CONTROL::UpdateSymbolInSchematic().

ClrSave()

void BASE_SCREEN::ClrSave ( )

inlineinherited

Definition at line 123 of file base_screen.h.

{ m_flagSave = false; }

References BASE_SCREEN::m_flagSave.

Referenced by SCH_EDIT_FRAME::SaveEEFile(), and PCB_EDIT_FRAME::SavePcbFile().

CountConnectedItems()

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

Definition at line 908 of file sch_screen.cpp.

{
    size_t count = 0;

    for( SCH_ITEM* item : Items() )
    {
        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 113 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

aItem

The schematic object to be deleted from the screen.

Definition at line 279 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 )
        SetModify();

    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 label 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::SetModify(), and EDA_ITEM::Type().

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.

thie list of components), 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 934 of file sch_screen.cpp.

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

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

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

References SCH_COMPONENT::AddSheetPathReferenceEntryIfMissing(), GetClientSheetPaths(), Items(), and SCH_COMPONENT_T.

Referenced by SCH_SCREENS::ClearAnnotationOfNewSheetPaths().

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 215 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( auto 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 84 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 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 93 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 102 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;

        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 188 of file sch_screen.h.

{ return m_aux_origin; }

References m_aux_origin.

GetBoundingBox()

const EDA_RECT EDA_ITEM::GetBoundingBox ( ) const

virtualinherited

Function GetBoundingBox returns 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, CENTER_DIMENSION, SCH_HIERLABEL, SCH_SHEET, SCH_GLOBALLABEL, SCH_COMPONENT, SCH_LABEL, WS_DRAW_ITEM_BITMAP, WS_DRAW_ITEM_TEXT, PCB_SHAPE, WS_DRAW_ITEM_PAGE, SCH_TEXT, DIMENSION_BASE, GERBER_DRAW_ITEM, LIB_PART, WS_DRAW_ITEM_RECT, LIB_PIN, LIB_ITEM, WS_DRAW_ITEM_POLYPOLYGONS, FOOTPRINT, FP_TEXT, SCH_LINE, LIB_FIELD, PCB_GROUP, WS_DRAW_ITEM_LINE, ZONE, PCB_TEXT, TRACK, SCH_FIELD, WS_DRAW_ITEM_BASE, PCB_MARKER, SCH_BITMAP, SCH_PIN, SCH_BUS_ENTRY_BASE, PCB_TARGET, GBR_LAYOUT, LIB_POLYLINE, LIB_ARC, SCH_NO_CONNECT, LIB_TEXT, LIB_BEZIER, SCH_MARKER, LIB_RECTANGLE, SCH_JUNCTION, and LIB_CIRCLE.

Definition at line 89 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 CN_ITEM::BBox(), EE_RTREE::contains(), FOOTPRINT::CoverageRatio(), LIB_ITEM::GetBoundingBox(), GetBoundingBoxes(), GERBVIEW_SELECTION::GetCenter(), BOARD_ITEM::GetCenter(), SCH_MOVE_TOOL::getConnectedDragItems(), getRect(), EE_SELECTION_TOOL::GuessSelectionCandidates(), EE_RTREE::insert(), insideArea(), SCH_EDIT_TOOL::Mirror(), SCH_EAGLE_PLUGIN::moveLabels(), 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  )

inline

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

inline

Returns a list of bus aliases defined in this screen.

Definition at line 491 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 176 of file sch_screen.h.

    {
        return wxT( "SCH_SCREEN" );
    }

GetClientSheetPaths()

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

inline

Returns

the sheet paths sharing this screen if 1 this screen is not in a complex hierarchy: the reference field can be used to store the component reference if > 1 this screen is in a complex hierarchy, and components must have a full alternate reference management

Definition at line 206 of file sch_screen.h.

    {
        return m_clientSheetPathList;
    }

References m_clientSheetPathList.

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

GetEditFlags()

STATUS_FLAGS EDA_ITEM::GetEditFlags ( ) const

inlineinherited

Definition at line 225 of file eda_item.h.

    {
        constexpr int mask = ( IS_NEW | IS_PASTED | IS_MOVED | IS_RESIZED | IS_DRAGGED |
                               IS_WIRE_IMAGE | STRUCT_DELETED );

        return m_flags & mask;
    }

References IS_DRAGGED, IS_MOVED, IS_NEW, IS_PASTED, IS_RESIZED, IS_WIRE_IMAGE, EDA_ITEM::m_flags, and STRUCT_DELETED.

Referenced by SCH_EDIT_TOOL::ChangeTextType(), EDA_ITEM::ClearEditFlags(), SCH_EDIT_FRAME::DeleteJunction(), SCH_EDIT_TOOL::editFieldText(), LIB_PIN_TOOL::EditPinProperties(), SCH_EDITOR_CONTROL::EditWithLibEdit(), SCH_COMPONENT::GetMsgPanelInfo(), SELECTION_CONDITIONS::Idle(), SELECTION_CONDITIONS::IdleSelection(), LIB_MOVE_TOOL::Main(), POINT_EDITOR::OnSelectionChange(), LIB_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_SYMBOL_PROPERTIES::TransferDataFromWindow(), DIALOG_TEXT_PROPERTIES::TransferDataFromWindow(), DIALOG_LABEL_EDITOR::TransferDataFromWindow(), DIALOG_FOOTPRINT_PROPERTIES::TransferDataFromWindow(), and SCH_EDIT_FRAME::TrimWire().

GetFileName()

const wxString& SCH_SCREEN::GetFileName ( void  ) const

inline

Definition at line 186 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(), SCH_LEGACY_PLUGIN::loadHeader(), NETLIST_EXPORTER_XML::makeDesignHeader(), DIALOG_SHEET_PROPERTIES::onSheetFilenameChanged(), SCH_EDITOR_CONTROL::Paste(), SCH_SHEET_PATH::PathHumanReadable(), DIALOG_PLOT_SCHEMATIC::Plot_1_Page_HPGL(), DIALOG_PLOT_SCHEMATIC::PlotOneSheetDXF(), DIALOG_PLOT_SCHEMATIC::plotOneSheetPDF(), DIALOG_PLOT_SCHEMATIC::plotOneSheetPS(), DIALOG_PLOT_SCHEMATIC::plotOneSheetSVG(), SCH_EDITOR_CONTROL::Print(), SCH_PRINTOUT::PrintPage(), SCH_EDIT_FRAME::Save_File(), SCH_EDIT_FRAME::SaveEEFile(), SCH_EDIT_FRAME::SaveProject(), SCH_EDIT_FRAME::SaveProjectSettings(), and SCH_SHEET::SearchHierarchy().

GetFlags()

STATUS_FLAGS EDA_ITEM::GetFlags ( ) const

inlineinherited

Definition at line 222 of file eda_item.h.

{ return m_flags; }

References EDA_ITEM::m_flags.

Referenced by BACK_ANNOTATE::applyChangelist(), ConvertOutlineToPolygon(), SCH_EDIT_FRAME::ConvertPart(), KIGFX::SCH_PAINTER::draw(), DRC_ENGINE::EvalRulesForItems(), SELECTION_TOOL::expandConnection(), insideArea(), PCB_INSPECTION_TOOL::InspectConstraints(), LIB_PART::LIB_PART(), DIALOG_DRC::OnDRCItemSelected(), LIB_PART::operator=(), SCH_EDIT_FRAME::SaveCopyInUndoList(), SCH_EDIT_FRAME::SchematicCleanUp(), SCH_EDIT_FRAME::SelectUnit(), WS_DATA_ITEM::SyncDrawItems(), WS_DATA_ITEM_POLYGONS::SyncDrawItems(), WS_DATA_ITEM_TEXT::SyncDrawItems(), WS_DATA_ITEM_BITMAP::SyncDrawItems(), and DIALOG_SYMBOL_PROPERTIES::TransferDataFromWindow().

GetFocusPosition()

virtual const wxPoint EDA_ITEM::GetFocusPosition ( ) const

inlinevirtualinherited

Function GetFocusPosition similar to GetPosition, but allows items to return their visual center rather than their anchor.

Reimplemented in BOARD, PCB_SHAPE, and TRACK.

Definition at line 333 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

)

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

Parameters

aItems

Hierarchical item list to fill.

Definition at line 950 of file sch_screen.cpp.

{
    static KICAD_T hierarchicalTypes[] = { SCH_COMPONENT_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_COMPONENT_T, SCH_GLOBAL_LABEL_T, and SCH_SHEET_T.

GetItem()

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

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

Parameters

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 310 of file sch_screen.cpp.

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

    for( auto 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
	)

Return a label item located at aPosition.

Parameters

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 1059 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 (SCH_TEXT*) item;

            break;

        default:
            ;
        }
    }

    return NULL;
}

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

Referenced by IsTerminalPoint().

GetLibSymbols()

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

inline

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

Returns

The list of unique LIB_PART object pointers.

Definition at line 462 of file sch_screen.h.

{ return m_libSymbols; }

References m_libSymbols.

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

GetLine()

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

Return a line item located at aPosition.

Parameters

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 1022 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() )
    {
        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 NULL;
}

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

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

GetMenuImage()

BITMAP_DEF EDA_ITEM::GetMenuImage ( ) const

virtualinherited

Function GetMenuImage returns 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_COMPONENT, PAD, FOOTPRINT, SCH_SHEET, CENTER_DIMENSION, SCH_HIERLABEL, LEADER, VIA, ORTHOGONAL_DIMENSION, SCH_GLOBALLABEL, SCH_LABEL, ALIGNED_DIMENSION, PCB_SHAPE, SCH_TEXT, GERBER_DRAW_ITEM, LIB_PIN, SCH_LINE, TRACK, FP_TEXT, SCH_BUS_BUS_ENTRY, SCH_SHEET_PIN, LIB_FIELD, SCH_FIELD, PCB_GROUP, SCH_BUS_WIRE_ENTRY, FP_SHAPE, SCH_BITMAP, LIB_ARC, PCB_TEXT, LIB_POLYLINE, SCH_NO_CONNECT, SCH_MARKER, LIB_TEXT, PCB_TARGET, SCH_JUNCTION, PCB_MARKER, LIB_CIRCLE, and LIB_RECTANGLE.

Definition at line 221 of file eda_item.cpp.

{
    return dummy_xpm;
}

References dummy_xpm.

Referenced by GERBVIEW_SELECTION_TOOL::disambiguationMenu(), PL_SELECTION_TOOL::doSelectionMenu(), EE_SELECTION_TOOL::doSelectionMenu(), and SELECTION_TOOL::doSelectionMenu().

GetMsgPanelInfo()

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

inlinevirtualinherited

Function GetMsgPanelInfo populates 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, LEADER, VIA, FOOTPRINT, SCH_SHEET, SCH_TEXT, SCH_COMPONENT, PCB_SHAPE, NETINFO_ITEM, GERBER_DRAW_ITEM, SCH_LINE, DIMENSION_BASE, LIB_PIN, LIB_ITEM, TRACK, FP_TEXT, PCB_GROUP, LIB_FIELD, SCH_BITMAP, FP_SHAPE, ZONE, SCH_BUS_ENTRY_BASE, SCH_MARKER, PCB_TEXT, LIB_BEZIER, PCB_MARKER, LIB_POLYLINE, LIB_ARC, LIB_TEXT, LIB_RECTANGLE, and LIB_CIRCLE.

Definition at line 283 of file eda_item.h.

    {
    }

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

GetPageCount()

int BASE_SCREEN::GetPageCount ( ) const

inlineinherited

Definition at line 137 of file base_screen.h.

{ return m_pageCount; }

References BASE_SCREEN::m_pageCount.

Referenced by KIGFX::SCH_VIEW::DisplaySheet(), SCH_SEXPR_PLUGIN::Format(), SCH_LEGACY_PLUGIN::Format(), DIALOG_PAGES_SETTINGS::initDialog(), DIALOG_PLOT_SCHEMATIC::Plot_1_Page_HPGL(), DIALOG_PLOT_SCHEMATIC::PlotOneSheetDXF(), DIALOG_PLOT_SCHEMATIC::plotOneSheetPDF(), DIALOG_PLOT_SCHEMATIC::plotOneSheetPS(), DIALOG_PLOT_SCHEMATIC::plotOneSheetSVG(), EDA_DRAW_FRAME::PrintWorkSheet(), PCB_EDIT_FRAME::SetPageSettings(), and DIALOG_PAGES_SETTINGS::UpdatePageLayoutExample().

GetPageNumber()

const wxString & BASE_SCREEN::GetPageNumber ( ) const

inherited

Definition at line 79 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::Plot_1_Page_HPGL(), DIALOG_PLOT_SCHEMATIC::PlotOneSheetDXF(), DIALOG_PLOT_SCHEMATIC::plotOneSheetPDF(), DIALOG_PLOT_SCHEMATIC::plotOneSheetPS(), DIALOG_PLOT_SCHEMATIC::plotOneSheetSVG(), EDA_DRAW_FRAME::PrintWorkSheet(), PCB_EDIT_FRAME::SetPageSettings(), and DIALOG_PAGES_SETTINGS::UpdatePageLayoutExample().

GetPageSettings()

const PAGE_INFO& SCH_SCREEN::GetPageSettings ( ) const

inline

Definition at line 181 of file sch_screen.h.

{ return m_paper; }

References m_paper.

Referenced by DIALOG_PLOT_SCHEMATIC::createHPGLFile(), DIALOG_PLOT_SCHEMATIC::createPSFile(), KIGFX::SCH_VIEW::DisplaySheet(), LIB_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(), 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 183 of file eda_item.h.

{ return m_parent; }

References EDA_ITEM::m_parent.

Referenced by SCH_EDIT_FRAME::AddItemToScreenAndUndoList(), DIALOG_SCH_EDIT_ONE_FIELD::DIALOG_SCH_EDIT_ONE_FIELD(), SCH_EDITOR_CONTROL::doCrossProbeSchToPcb(), KIGFX::SCH_PAINTER::draw(), SCH_EDIT_TOOL::editFieldText(), FormatProbeItem(), SCH_PIN::GetParentSymbol(), EE_SELECTION_TOOL::highlight(), highlightNet(), EE_SELECTION_TOOL::Main(), SCH_EDIT_TOOL::Mirror(), SCH_MOVE_TOOL::moveItem(), SCH_EDITOR_CONTROL::nextMatch(), DIALOG_SCH_EDIT_ONE_FIELD::onScintillaCharAdded(), BOARD_COMMIT::parentObject(), SELECTION_TOOL::RebuildSelection(), SCH_BASE_FRAME::RefreshSelection(), 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_FIELDS_EDITOR_GLOBAL::TransferDataToWindow(), EE_SELECTION_TOOL::unhighlight(), DIALOG_SCH_EDIT_ONE_FIELD::UpdateField(), EE_TOOL_BASE< SCH_BASE_FRAME >::updateItem(), and SCH_BASE_FRAME::UpdateItem().

GetPin()

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

Test the screen for a component pin item at aPosition.

Parameters

aPosition	Position to test.
aSymbol	The component 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 839 of file sch_screen.cpp.

{
    SCH_COMPONENT*  candidate = NULL;
    LIB_PIN*        pin = NULL;

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

        if( aEndPointOnly )
        {
            pin = NULL;

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

            for( pin = candidate->GetPartRef()->GetNextPin(); pin;
                 pin = candidate->GetPartRef()->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_COMPONENT::GetConvert(), LIB_ITEM::GetConvert(), SCH_COMPONENT::GetDrawItem(), SCH_COMPONENT::GetPartRef(), SCH_COMPONENT::GetPinPhysicalPosition(), SCH_COMPONENT::GetUnit(), LIB_ITEM::GetUnit(), Items(), LIB_PIN_T, NULL, and SCH_COMPONENT_T.

Referenced by IsTerminalPoint(), and MarkConnections().

GetPosition()

virtual wxPoint EDA_ITEM::GetPosition ( ) const

inlinevirtualinherited

Reimplemented in SCH_COMPONENT, SCH_SHEET, VIA, DELETED_BOARD_ITEM, WS_DRAW_ITEM_BITMAP, BOARD, SCH_TEXT, ARC, WS_DRAW_ITEM_TEXT, WS_DRAW_ITEM_PAGE, LIB_PIN, SCH_LINE, WS_DRAW_ITEM_RECT, FOOTPRINT, GERBER_DRAW_ITEM, SCH_FIELD, WS_DRAW_ITEM_POLYPOLYGONS, LIB_FIELD, PAD, SCH_BITMAP, WS_DRAW_ITEM_LINE, PCB_SHAPE, DIMENSION_BASE, ZONE, SCH_BUS_ENTRY_BASE, SCH_NO_CONNECT, PCB_GROUP, NETINFO_ITEM, TRACK, SCH_MARKER, KIGFX::ORIGIN_VIEWITEM, SCH_JUNCTION, LIB_POLYLINE, LIB_ARC, SCH_PIN, FP_TEXT, LIB_TEXT, LIB_BEZIER, LIB_RECTANGLE, LIB_CIRCLE, PCB_TEXT, PCB_MARKER, and PCB_TARGET.

Definition at line 325 of file eda_item.h.

{ return wxPoint(); }

Referenced by EE_GRID_HELPER::computeAnchors(), GRID_HELPER::computeAnchors(), SCH_EDIT_FRAME::DeleteJunction(), KIGFX::PCB_PAINTER::draw(), CONNECTION_GRAPH::ercCheckBusToBusConflicts(), CONNECTION_GRAPH::ercCheckBusToNetConflicts(), CONNECTION_GRAPH::ercCheckNoConnects(), SELECTION_TOOL::findCallback(), GERBVIEW_SELECTION::GetCenter(), EDA_ITEM::GetFocusPosition(), SCH_FIELD::GetParentPosition(), POSITION_RELATIVE_TOOL::GetSelectionAnchorPosition(), GetSheets(), PCBNEW_SELECTION::GetTopLeftItem(), EE_SELECTION::GetTopLeftItem(), BOARD_ITEM::GetX(), BOARD_ITEM::GetY(), LIB_MOVE_TOOL::Main(), SCH_MOVE_TOOL::Main(), EDIT_POINTS_FACTORY::Make(), LIB_EDIT_TOOL::Mirror(), SCH_EDIT_TOOL::Mirror(), EDIT_TOOL::MoveExact(), SCH_ITEM::operator<(), PL_EDIT_TOOL::Paste(), SCH_EDITOR_CONTROL::Paste(), PCBNEW_CONTROL::placeBoardItems(), DRAWING_TOOL::PlaceImportedGraphics(), DRAWING_TOOL::PlaceText(), BACK_ANNOTATE::processNetNameChange(), PCB_BASE_EDIT_FRAME::PutDataInPreviousState(), SCH_EDIT_TOOL::RepeatDrawItem(), LIB_EDIT_TOOL::Rotate(), SCH_EDIT_TOOL::Rotate(), 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 197 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

Function GetSelectMenuText returns 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_COMPONENT, PAD, BOARD, FOOTPRINT, SCH_SHEET, SCH_HIERLABEL, VIA, SCH_GLOBALLABEL, DELETED_BOARD_ITEM, SCH_LABEL, WS_DRAW_ITEM_BITMAP, PCB_SHAPE, WS_DRAW_ITEM_TEXT, SCH_TEXT, GERBER_DRAW_ITEM, LIB_PIN, WS_DRAW_ITEM_PAGE, DIMENSION_BASE, WS_DRAW_ITEM_RECT, SCH_LINE, TRACK, FP_TEXT, SCH_BUS_BUS_ENTRY, SCH_SHEET_PIN, LIB_FIELD, WS_DRAW_ITEM_POLYPOLYGONS, SCH_FIELD, PCB_GROUP, SCH_BUS_WIRE_ENTRY, WS_DRAW_ITEM_LINE, FP_SHAPE, LIB_ARC, SCH_BITMAP, PCB_TEXT, LIB_POLYLINE, SCH_NO_CONNECT, LIB_TEXT, SCH_MARKER, PCB_TARGET, PCB_MARKER, LIB_CIRCLE, LIB_RECTANGLE, SCH_JUNCTION, SCH_PIN, and DELETED_SHEET_ITEM.

Definition at line 123 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(), SELECTION_TOOL::doSelectionMenu(), DRC_ENGINE::EvalRulesForItems(), PCB_MARKER::GetMsgPanelInfo(), RC_TREE_MODEL::GetValue(), PCB_INSPECTION_TOOL::InspectClearance(), PCB_INSPECTION_TOOL::InspectConstraints(), RC_ITEM::ShowReport(), and DIALOG_POSITION_RELATIVE::UpdateAnchor().

GetSheetInstances()

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

inline

Definition at line 501 of file sch_screen.h.

    {
        return m_sheetInstances;
    }

References m_sheetInstances.

GetSheetLabel()

SCH_SHEET_PIN * SCH_SCREEN::GetSheetLabel

(

const wxPoint &

aPosition

)

Test the screen if aPosition is a sheet label object.

Parameters

aPosition

The position to test.

Returns

The sheet label object if found otherwise NULL.

Definition at line 890 of file sch_screen.cpp.

{
    SCH_SHEET_PIN* sheetPin = nullptr;

    for( SCH_ITEM* item : Items().OfType( SCH_SHEET_T ) )
    {
        auto sheet = static_cast<SCH_SHEET*>( item );

        sheetPin = sheet->GetPin( aPosition );

        if( sheetPin )
            break;
    }

    return sheetPin;
}

References Items(), and SCH_SHEET_T.

Referenced by IsTerminalPoint().

GetSheets()

void SCH_SCREEN::GetSheets

(

std::vector< SCH_ITEM * > *

aItems

)

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

Parameters

aItems

Definition at line 962 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
            {
                long a_order = 0;
                long b_order = 0;

                for( const SCH_FIELD& field : static_cast<SCH_SHEET*>( a )->GetFields() )
                {
                    if( field.GetName().CmpNoCase( wxT( "Order" ) ) == 0 )
                    {
                        field.GetText().ToLong( &a_order );
                        break;
                    }
                }

                for( const SCH_FIELD& field : static_cast<SCH_SHEET*>( b )->GetFields() )
                {
                    if( field.GetName().CmpNoCase( wxT( "Order" ) ) == 0 )
                    {
                        field.GetText().ToLong( &b_order );
                        break;
                    }
                }

                if( a_order == b_order )
                {
                    if( a->GetPosition().x == b->GetPosition().x )
                        return a->GetPosition().y < b->GetPosition().y;

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

                return a_order < b_order;
            } );
}

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

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

GetState()

int EDA_ITEM::GetState ( int  type ) const

inlineinherited

Definition at line 204 of file eda_item.h.

    {
        return m_status & type;
    }

References EDA_ITEM::m_status.

Referenced by TRACK::GetMsgPanelInfoBase_Common(), and TRACK::IsLocked().

GetStatus()

STATUS_FLAGS EDA_ITEM::GetStatus ( ) const

inlineinherited

Definition at line 217 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 496 of file sch_screen.h.

    {
        return m_symbolInstances;
    }

References m_symbolInstances.

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

GetTitleBlock()

const TITLE_BLOCK& SCH_SCREEN::GetTitleBlock ( ) const

inline

Definition at line 191 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_BASE_FRAME::GetTitleBlock(), and NETLIST_EXPORTER_XML::makeDesignHeader().

GetVirtualPageNumber()

int BASE_SCREEN::GetVirtualPageNumber ( ) const

inlineinherited

Definition at line 140 of file base_screen.h.

{ return m_virtualPageNumber; }

References BASE_SCREEN::m_virtualPageNumber.

Referenced by KIGFX::SCH_VIEW::DisplaySheet(), SCH_SEXPR_PLUGIN::Format(), SCH_LEGACY_PLUGIN::Format(), DIALOG_PAGES_SETTINGS::initDialog(), DIALOG_PLOT_SCHEMATIC::Plot_1_Page_HPGL(), DIALOG_PLOT_SCHEMATIC::PlotOneSheetDXF(), DIALOG_PLOT_SCHEMATIC::plotOneSheetPDF(), DIALOG_PLOT_SCHEMATIC::plotOneSheetPS(), DIALOG_PLOT_SCHEMATIC::plotOneSheetSVG(), EDA_DRAW_FRAME::PrintWorkSheet(), and DIALOG_PAGES_SETTINGS::UpdatePageLayoutExample().

GetWire()

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

inline

Definition at line 434 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 ( STATUS_FLAGS  aFlag )

inlineinherited

Definition at line 223 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(), LIB_PIN_TOOL::PlacePin(), SCH_EDIT_TOOL::Rotate(), DRC_TEST_PROVIDER_HOLE_CLEARANCE::Run(), EE_TOOL_BASE< SCH_BASE_FRAME >::saveCopyInUndoList(), DRC_TEST_PROVIDER_COPPER_CLEARANCE::testPadClearances(), DRC_TEST_PROVIDER_COPPER_CLEARANCE::testTrackClearances(), and EE_POINT_EDITOR::updateParentItem().

HasItems()

bool SCH_SCREEN::HasItems

(

KICAD_T

aItemType

)

const

Definition at line 121 of file sch_screen.cpp.

{
    EE_RTREE::EE_TYPE sheets = const_cast<EE_RTREE&>( m_rtree ).OfType( aItemType );

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

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

Referenced by HasSheets().

HasSheets()

bool SCH_SCREEN::HasSheets ( ) const

inline

Definition at line 169 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

Function HitTest tests if aPosition is contained within or on the bounding box of an 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_COMPONENT, SCH_SHEET, PAD, VIA, FOOTPRINT, WS_DRAW_ITEM_BITMAP, ZONE, ARC, SCH_TEXT, WS_DRAW_ITEM_TEXT, PCB_SHAPE, WS_DRAW_ITEM_PAGE, GERBER_DRAW_ITEM, SCH_LINE, DIMENSION_BASE, WS_DRAW_ITEM_RECT, LIB_PIN, SCH_SHEET_PIN, SCH_FIELD, TRACK, FP_TEXT, LIB_ITEM, WS_DRAW_ITEM_POLYPOLYGONS, LIB_FIELD, WS_DRAW_ITEM_LINE, SCH_BITMAP, PCB_GROUP, SCH_BUS_ENTRY_BASE, SCH_JUNCTION, SCH_NO_CONNECT, SCH_MARKER, WS_DRAW_ITEM_BASE, PCB_TEXT, SCH_PIN, PCB_TARGET, LIB_POLYLINE, PCB_MARKER, LIB_ARC, LIB_BEZIER, LIB_TEXT, LIB_RECTANGLE, LIB_CIRCLE, and KIGFX::RATSNEST_VIEWITEM.

Definition at line 295 of file eda_item.h.

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

Referenced by SCH_MOVE_TOOL::getConnectedDragItems(), PL_SELECTION_TOOL::guessSelectionCandidates(), EE_SELECTION_TOOL::GuessSelectionCandidates(), WS_DRAW_ITEM_BASE::HitTest(), LIB_ITEM::HitTest(), EE_COLLECTOR::Inspect(), GERBER_COLLECTOR::Inspect(), GENERAL_COLLECTOR::Inspect(), CN_VISITOR::operator()(), EE_SELECTION_TOOL::selectMultiple(), and SELECTION_TOOL::selectMultiple().

HitTest() [2/2]

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

inlinevirtualinherited

Function HitTest tests if aRect intersects or is contained within the bounding box of an 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_COMPONENT, SCH_SHEET, PAD, ZONE, VIA, FOOTPRINT, WS_DRAW_ITEM_BITMAP, ARC, SCH_TEXT, WS_DRAW_ITEM_TEXT, PCB_SHAPE, GERBER_DRAW_ITEM, SCH_LINE, DIMENSION_BASE, LIB_PIN, SCH_FIELD, TRACK, LIB_ITEM, FP_TEXT, WS_DRAW_ITEM_POLYPOLYGONS, SCH_BITMAP, PCB_GROUP, SCH_BUS_ENTRY_BASE, SCH_JUNCTION, SCH_NO_CONNECT, WS_DRAW_ITEM_BASE, PCB_TEXT, PCB_TARGET, LIB_POLYLINE, LIB_ARC, LIB_BEZIER, LIB_TEXT, and LIB_CIRCLE.

Definition at line 309 of file eda_item.h.

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

IncRefCount()

void SCH_SCREEN::IncRefCount

(

)

Definition at line 107 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 48 of file base_screen.cpp.

{
    if( m_Center )
    {
        m_crossHairPosition.x = 0;
        m_crossHairPosition.y = 0;

        m_DrawOrg.x = -aPageSizeIU.x / 2;
        m_DrawOrg.y = -aPageSizeIU.y / 2;
    }
    else
    {
        m_crossHairPosition.x = aPageSizeIU.x / 2;
        m_crossHairPosition.y = aPageSizeIU.y / 2;

        m_DrawOrg.x = 0;
        m_DrawOrg.y = 0;
    }

    m_LocalOrigin = { 0, 0 };
}

References BASE_SCREEN::m_Center, BASE_SCREEN::m_crossHairPosition, 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(), GERBVIEW_FRAME::SetPageSettings(), PL_EDITOR_FRAME::SetPageSettings(), and PCB_BASE_FRAME::SetPageSettings().

IsBrightened()

bool EDA_ITEM::IsBrightened ( ) const

inlineinherited

Definition at line 193 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::WS_RENDER_SETTINGS::GetColor(), KIGFX::PCB_RENDER_SETTINGS::GetColor(), KIGFX::SCH_PAINTER::getRenderColor(), SCH_EDITOR_CONTROL::UpdateFind(), and SCH_EDITOR_CONTROL::UpdateNetHighlighting().

IsDragging()

bool EDA_ITEM::IsDragging ( ) const

inlineinherited

Definition at line 189 of file eda_item.h.

{ return m_flags & IS_DRAGGED; }

References IS_DRAGGED, and EDA_ITEM::m_flags.

Referenced by DIALOG_SYMBOL_PROPERTIES::DIALOG_SYMBOL_PROPERTIES(), and KIGFX::SCH_PAINTER::setDeviceColors().

IsEmpty()

bool SCH_SCREEN::IsEmpty ( )

inline

Definition at line 162 of file sch_screen.h.

    {
        return m_rtree.empty();
    }

References EE_RTREE::empty(), and m_rtree.

IsForceVisible()

bool EDA_ITEM::IsForceVisible ( ) const

inlineinherited

Definition at line 274 of file eda_item.h.

{ return m_forceVisible; }

References EDA_ITEM::m_forceVisible.

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

IsJunctionNeeded()

bool SCH_SCREEN::IsJunctionNeeded	(	const wxPoint &	aPosition,
		bool	aNew = false
	)

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

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 component pin;
• two or more wire endpoints and a component pin.

Parameters

aPosition	The position to test.
aNew	Checks if a new junction is needed, i.e. there isn't one already

Returns

True if a junction is required at aPosition.

A line with a midpoint should be counted as two endpoints for this calculation because the junction will split the line into two if there is another item present at the point.

Overlapping lines that point in the same direction should not be counted as extra end_points.

Definition at line 371 of file sch_screen.cpp.

{
    enum { WIRES, BUSES } layers;

    bool    has_nonparallel[ sizeof( layers ) ] = { false };
    int     end_count[ sizeof( layers ) ] = { 0 };
    int     entry_count = 0;
    int     pin_count = 0;

    std::vector<SCH_LINE*> lines[ sizeof( layers ) ];

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

        switch( item->Type() )
        {
        case SCH_JUNCTION_T:
            if( aNew && item->HitTest( aPosition ) )
                return false;

            break;

        case SCH_LINE_T:
            if( item->HitTest( aPosition, 0 ) )
            {
                if( item->GetLayer() == LAYER_WIRE )
                    lines[WIRES].push_back( (SCH_LINE*) item );
                else if( item->GetLayer() == LAYER_BUS )
                    lines[BUSES].push_back( (SCH_LINE*) item );
            }
            break;

        case SCH_BUS_WIRE_ENTRY_T:
        case SCH_BUS_BUS_ENTRY_T:
            if( item->IsConnected( aPosition ) )
                entry_count++;

            break;

        case SCH_COMPONENT_T:
        case SCH_SHEET_T:
            if( item->IsConnected( aPosition ) )
                pin_count++;

            break;

        default:
            break;
        }
    }

    for( int i : { WIRES, BUSES } )
    {
        bool removed_overlapping = false;
        bool mid_point = false;

        for( auto line = lines[i].begin(); line < lines[i].end(); line++ )
        {
            if( !(*line)->IsEndPoint( aPosition ) )
                mid_point = true;
            else
                end_count[i]++;

            for( auto second_line = lines[i].end() - 1; second_line > line; second_line-- )
            {
                if( !(*line)->IsParallel( *second_line ) )
                    has_nonparallel[i] = true;
                else if( !removed_overlapping
                         && (*line)->IsSameQuadrant( *second_line, aPosition ) )
                {
                    removed_overlapping = true;
                }
            }
        }

        if( mid_point )
            end_count[i] += 2;

        if( removed_overlapping )
            end_count[i]--;
    }

    // If there are three or more endpoints
    if( pin_count && pin_count + end_count[WIRES] > 2 )
        return true;

    // If there is at least one segment that ends on a non-parallel line or
    // junction of two other lines
    if( has_nonparallel[WIRES] && end_count[WIRES] > 2 )
        return true;

    // Check for bus - bus junction requirements
    if( has_nonparallel[BUSES] && end_count[BUSES] > 2 )
        return true;

    // Check for bus - bus entry requirements
    if( !aNew && entry_count && end_count[BUSES] )
        return true;

    return false;
}

References Items(), LAYER_BUS, LAYER_WIRE, EE_RTREE::Overlapping(), SCH_BUS_BUS_ENTRY_T, SCH_BUS_WIRE_ENTRY_T, SCH_COMPONENT_T, SCH_JUNCTION_T, SCH_LINE_T, SCH_SHEET_T, and STRUCT_DELETED.

Referenced by SCH_EDIT_FRAME::AddItemToScreenAndUndoList(), SCH_LINE_WIRE_BUS_TOOL::AddJunctionsIfNeeded(), SCH_EDIT_TOOL::BreakWire(), SCH_EDIT_TOOL::DoDelete(), SCH_LINE_WIRE_BUS_TOOL::finishSegments(), SCH_EDIT_FRAME::FixupJunctions(), SCH_MOVE_TOOL::Main(), SCH_LINE::MergeOverlap(), and SCH_EDIT_FRAME::SchematicCleanUp().

IsModified()

bool EDA_ITEM::IsModified ( ) const

inlineinherited

Definition at line 186 of file eda_item.h.

{ return m_flags & IS_CHANGED; }

References IS_CHANGED, and EDA_ITEM::m_flags.

Referenced by PCB_EDIT_FRAME::OpenProjectFiles().

IsModify()

bool BASE_SCREEN::IsModify ( ) const

inlineinherited

Definition at line 124 of file base_screen.h.

{ return m_flagModified; }

References BASE_SCREEN::m_flagModified.

Referenced by 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 SYMBOL_EDIT_FRAME::setupUIConditions().

IsMoving()

bool EDA_ITEM::IsMoving ( ) const

inlineinherited

Definition at line 188 of file eda_item.h.

{ return m_flags & IS_MOVED; }

References IS_MOVED, and EDA_ITEM::m_flags.

Referenced by SCH_EDIT_FRAME::AddItemToScreenAndUndoList(), LIB_PIN::CalcEdit(), LIB_ARC::CalcRadiusAngles(), KIGFX::SCH_PAINTER::draw(), LIB_EDIT_TOOL::Duplicate(), LIB_EDIT_TOOL::Mirror(), SCH_EDIT_TOOL::Mirror(), PCB_BASE_FRAME::PlaceFootprint(), LIB_EDIT_TOOL::Rotate(), SCH_EDIT_TOOL::Rotate(), and KIGFX::SCH_PAINTER::setDeviceColors().

IsNew()

bool EDA_ITEM::IsNew ( ) const

inlineinherited

Definition at line 187 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::ChangeTextType(), SCH_EDIT_TOOL::ConvertDeMorgan(), LIB_EDIT_TOOL::Duplicate(), SCH_EDIT_TOOL::Duplicate(), LIB_PIN_TOOL::EditPinProperties(), LIB_DRAWING_TOOLS::Init(), SCH_LINE_WIRE_BUS_TOOL::IsDrawingLineWireOrBus(), PL_EDIT_TOOL::Main(), EE_POINT_EDITOR::Main(), LIB_MOVE_TOOL::Main(), PL_POINT_EDITOR::Main(), SCH_MOVE_TOOL::Main(), EDIT_TOOL::MoveExact(), PCB_BASE_FRAME::PlaceFootprint(), LIB_PIN_TOOL::PlacePin(), DIALOG_SHEET_PIN_PROPERTIES::TransferDataFromWindow(), DIALOG_SHEET_PROPERTIES::TransferDataFromWindow(), DIALOG_LABEL_EDITOR::TransferDataFromWindow(), DIALOG_SHEET_PROPERTIES::TransferDataToWindow(), and SCH_EDIT_FRAME::UpdateSymbolFromEditor().

IsReplaceable()

virtual bool EDA_ITEM::IsReplaceable ( ) const

inlinevirtualinherited

Function IsReplaceable.

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

Definition at line 490 of file eda_item.h.

{ return false; }

Referenced by EDA_ITEM::Matches().

IsResized()

bool EDA_ITEM::IsResized ( ) const

inlineinherited

Definition at line 192 of file eda_item.h.

{ return m_flags & IS_RESIZED; }

References IS_RESIZED, and EDA_ITEM::m_flags.

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

IsSave()

bool BASE_SCREEN::IsSave ( ) const

inlineinherited

Definition at line 125 of file base_screen.h.

{ return m_flagSave; }

References BASE_SCREEN::m_flagSave.

Referenced by SCH_EDIT_FRAME::doAutoSave().

IsSelected()

bool EDA_ITEM::IsSelected ( ) const

inlineinherited

Definition at line 191 of file eda_item.h.

{ return m_flags & SELECTED; }

References EDA_ITEM::m_flags, and SELECTED.

Referenced by SCH_EDIT_TOOL::ChangeTextType(), SCH_EDIT_FRAME::ConvertPart(), DIALOG_CHANGE_SYMBOLS::DIALOG_CHANGE_SYMBOLS(), KIGFX::SCH_PAINTER::draw(), KIGFX::PCB_PAINTER::draw(), KIGFX::WS_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(), SCH_LINE::MergeOverlap(), SCH_EDIT_TOOL::Mirror(), SCH_MOVE_TOOL::moveItem(), BOARD_COMMIT::Push(), SELECTION_TOOL::RebuildSelection(), EE_SELECTION_TOOL::RebuildSelection(), C3D_RENDER_OGL_LEGACY::render_3D_footprint(), SCH_EDIT_TOOL::Rotate(), EE_TOOL_BASE< SCH_BASE_FRAME >::saveCopyInUndoList(), SCH_EDIT_FRAME::SchematicCleanUp(), SELECTION_TOOL::select(), GERBVIEW_SELECTION_TOOL::select(), EE_SELECTION_TOOL::selectMultiple(), SELECTION_TOOL::selectMultiple(), GERBVIEW_SELECTION_TOOL::selectPoint(), KIGFX::SCH_PAINTER::setDeviceColors(), GERBVIEW_SELECTION_TOOL::unselect(), and WS_PROXY_UNDO_ITEM::WS_PROXY_UNDO_ITEM().

IsTerminalPoint()

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

Test if aPosition is a connection point on aLayer.

Parameters

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 481 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()." ) );

    SCH_SHEET_PIN* label;
    SCH_TEXT*      text;
    SCH_CONNECTION conn;

    switch( aLayer )
    {
    case LAYER_BUS:

        if( GetBus( aPosition ) )
            return true;

        label = GetSheetLabel( aPosition );

        if( label && conn.MightBeBusLabel( label->GetText() ) && label->IsConnected( aPosition ) )
            return true;

        text = GetLabel( aPosition );

        if( text && conn.MightBeBusLabel( text->GetText() ) && text->IsConnected( aPosition )
            && (text->Type() != SCH_LABEL_T) )
            return true;

        break;

    case LAYER_NOTES:

        if( GetLine( aPosition ) )
            return true;

        break;

    case LAYER_WIRE:
        if( GetItem( aPosition, Mils2iu( 6 ), SCH_BUS_WIRE_ENTRY_T) )
            return true;

        if( GetItem( aPosition, Mils2iu( 6 ), SCH_BUS_BUS_ENTRY_T) )
            return true;

        if( GetItem( aPosition, Schematic()->Settings().m_JunctionSize, SCH_JUNCTION_T ) )
            return true;

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

        if( GetWire( aPosition ) )
            return true;

        text = GetLabel( aPosition );

        if( text && text->IsConnected( aPosition ) && !conn.MightBeBusLabel( text->GetText() ) )
            return true;

        label = GetSheetLabel( aPosition );

        if( label && label->IsConnected( aPosition ) && !conn.MightBeBusLabel( label->GetText() ) )
            return true;

        break;

    default:
        break;
    }

    return false;
}

References GetBus(), GetItem(), GetLabel(), GetLine(), GetPin(), GetSheetLabel(), EDA_TEXT::GetText(), GetWire(), SCH_ITEM::IsConnected(), LAYER_BUS, LAYER_NOTES, LAYER_WIRE, SCHEMATIC_SETTINGS::m_JunctionSize, SCH_CONNECTION::MightBeBusLabel(), NULL, SCH_BUS_BUS_ENTRY_T, SCH_BUS_WIRE_ENTRY_T, SCH_JUNCTION_T, SCH_LABEL_T, Schematic(), SCHEMATIC::Settings(), and EDA_ITEM::Type().

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

Function IsType Checks 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 VIA, SCH_LABEL, DIMENSION_BASE, PAD, PCB_SHAPE, SCH_FIELD, SCH_LINE, FP_TEXT, FP_SHAPE, and PCB_TEXT.

Definition at line 250 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_LINE_WIRE_BUS_TOOL::IsDrawingBus(), SCH_LINE_WIRE_BUS_TOOL::IsDrawingLine(), SCH_LINE_WIRE_BUS_TOOL::IsDrawingWire(), PCB_TEXT::IsType(), FP_SHAPE::IsType(), FP_TEXT::IsType(), SCH_LINE::IsType(), SCH_FIELD::IsType(), PCB_SHAPE::IsType(), PAD::IsType(), DIMENSION_BASE::IsType(), SCH_LABEL::IsType(), 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 190 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

Definition at line 159 of file sch_screen.h.

{ return m_rtree; }

References m_rtree.

Referenced by SCH_MOVE_TOOL::AlignElements(), SCH_SHEET_LIST::AnnotatePowerSymbols(), SCH_EDIT_FRAME::BreakSegments(), SCH_EDIT_FRAME::BreakSegmentsOnJunctions(), 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(), EnsureAlternateReferencesExist(), CONNECTION_GRAPH::ercCheckHierSheets(), SCH_SHEET_LIST::FillItemMap(), SCH_EDITOR_CONTROL::FindComponentAndItem(), SCH_LINE_WIRE_BUS_TOOL::finishSegments(), SCH_EDIT_FRAME::FixupJunctions(), SCH_SEXPR_PLUGIN::Format(), SCH_LEGACY_PLUGIN::Format(), AUTOPLACER::get_possible_colliders(), SCH_MOVE_TOOL::getConnectedDragItems(), GetHierarchicalItems(), GetItem(), SCH_SHEET_LIST::GetItem(), GetLabel(), GetLine(), GetPin(), getSheetBbox(), GetSheetLabel(), SCH_LINE_WIRE_BUS_TOOL::getSheetPin(), GetSheets(), SCH_SCREENS::HasNoFullyDefinedLibIds(), SCH_SHEET::HasUndefinedPins(), SCH_DRAWING_TOOLS::importHierLabel(), SCH_EDIT_TOOL::Init(), IsJunctionNeeded(), CADSTAR_SCH_ARCHIVE_LOADER::Load(), SCH_SEXPR_PLUGIN::loadHierarchy(), SCH_LEGACY_PLUGIN::loadHierarchy(), SCH_EDIT_FRAME::LoadSheetFromFile(), SCH_SHEET::LocatePathOfScreen(), SCH_MOVE_TOOL::Main(), EDIT_POINTS_FACTORY::Make(), NETLIST_EXPORTER_XML::makeSymbols(), MarkConnections(), SCH_EDITOR_CONTROL::nextMatch(), DIALOG_SHEET_PIN_PROPERTIES::onComboBox(), SCH_EDITOR_CONTROL::Paste(), Plot(), Print(), DIALOG_CHANGE_SYMBOLS::processMatchingSymbols(), NETLIST_EXPORTER_PSPICE::ProcessNetlist(), EE_SELECTION_TOOL::RebuildSelection(), DIALOG_SYMBOL_REMAP::remapSymbolsToLibTable(), Remove(), SCH_SHEET_LIST::ReplaceLegacySheetPaths(), SCH_EDIT_FRAME::SaveProject(), SCH_EDIT_FRAME::SchematicCleanUp(), SCH_SHEET::SearchHierarchy(), 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::updatePastedInstances(), UpdateSymbolLinks(), and NETLIST_EXPORTER_ORCADPCB2::WriteNetlist().

Items() [2/2]

const EE_RTREE& SCH_SCREEN::Items ( ) const

inline

Definition at line 160 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

IterateForward( EDA_ITEM*, INSPECTOR, void*, const KICAD_T )

IterateForward( EDA_ITEM*, INSPECTOR, void*, const KICAD_T )

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

Definition at line 372 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

IterateForward( EDA_ITEM*, INSPECTOR, void*, const KICAD_T )

IterateForward( EDA_ITEM*, INSPECTOR, void*, const KICAD_T )

This changes first parameter to avoid the DList and use std::vector instead

Definition at line 393 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 component pin.

Parameters

aSegment

The segment to test for connections.

Definition at line 326 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(), NULL, 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(), NULL, SCH_JUNCTION_T, SCH_LINE_T, and EDA_ITEM::Type().

Referenced by EE_SELECTION_TOOL::SelectConnection().

Matches() [1/2]

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

inlinevirtualinherited

Function Matches compares 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_COMPONENT, SCH_SHEET, SCH_TEXT, SCH_SHEET_PIN, SCH_FIELD, SCH_PIN, SCH_MARKER, PCB_MARKER, FP_TEXT, and PCB_TEXT.

Definition at line 446 of file eda_item.h.

    {
        return false;
    }

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

Matches() [2/2]

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

protectedinherited

Function Matches compares 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 132 of file eda_item.cpp.

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

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

    if( aSearchData.GetFlags() & wxFR_WHOLEWORD )
        return aText.IsSameAs( searchText, aSearchData.GetFlags() & wxFR_MATCHCASE );

    if( aSearchData.GetFlags() & FR_MATCH_WILDCARD )
    {
        if( aSearchData.GetFlags() & wxFR_MATCHCASE )
            return text.Matches( searchText );

        return text.MakeUpper().Matches( searchText.MakeUpper() );
    }

    if( aSearchData.GetFlags() & wxFR_MATCHCASE )
        return aText.Find( searchText ) != wxNOT_FOUND;

    return text.MakeUpper().Find( searchText.MakeUpper() ) != wxNOT_FOUND;
}

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

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

Place()

void SCH_SCREEN::Place ( SCH_EDIT_FRAME *  frame, wxDC *  DC  )

inline

Definition at line 248 of file sch_screen.h.

{ };

Plot()

void SCH_SCREEN::Plot

(

PLOTTER *

aPlotter

)

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

aPlotter

The plotter object to plot to.

Sort to ensure plot-order consistency with screen drawing

Definition at line 779 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( auto 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( SCH_ITEM* item : bitmaps )
    {
        aPlotter->SetCurrentLineWidth( std::max( item->GetPenWidth(), defaultPenWidth ) );
        item->Plot( aPlotter );
    }

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

    for( 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::Plot_1_Page_HPGL(), DIALOG_PLOT_SCHEMATIC::PlotOneSheetDXF(), DIALOG_PLOT_SCHEMATIC::plotOneSheetPDF(), DIALOG_PLOT_SCHEMATIC::plotOneSheetPS(), and DIALOG_PLOT_SCHEMATIC::plotOneSheetSVG().

Print()

void SCH_SCREEN::Print

(

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 738 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( auto 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( auto item : bitmaps )
        item->Print( aSettings, wxPoint( 0, 0 ) );

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

    for( auto 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

aItem

Item to be removed from schematic.

Returns

True if we successfully removed the item

Definition at line 241 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_COMPONENT_T )
    {
        SCH_COMPONENT* removedSymbol = static_cast<SCH_COMPONENT*>( aItem );

        bool removeUnusedLibSymbol = true;

        for( SCH_ITEM* item : Items().OfType( SCH_COMPONENT_T ) )
        {
            SCH_COMPONENT* symbol = static_cast<SCH_COMPONENT*>( 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_COMPONENT::GetSchSymbolLibraryName(), Items(), m_libSymbols, m_rtree, EE_RTREE::remove(), SCH_COMPONENT_T, and EDA_ITEM::Type().

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

Replace() [1/2]

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

staticinherited

Helper function used in search and replace dialog Function Replace performs 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 159 of file eda_item.cpp.

{
    wxString searchString = (aSearchData.GetFlags() & wxFR_MATCHCASE) ? aText : aText.Upper();

    int result = searchString.Find( (aSearchData.GetFlags() & wxFR_MATCHCASE) ?
                                    aSearchData.GetFindString() :
                                    aSearchData.GetFindString().Upper() );

    if( result == wxNOT_FOUND )
        return false;

    wxString prefix = aText.Left( result );
    wxString suffix;

    if( aSearchData.GetFindString().length() + result < aText.length() )
        suffix = aText.Right( aText.length() - ( aSearchData.GetFindString().length() + result ) );

    wxLogTrace( traceFindReplace, wxT( "Replacing '%s', prefix '%s', replace '%s', suffix '%s'." ),
                aText, prefix, aSearchData.GetReplaceString(), suffix );

    aText = prefix + aSearchData.GetReplaceString() + suffix;

    return true;
}

References traceFindReplace.

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

Replace() [2/2]

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

inlinevirtualinherited

Function Replace performs 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_SHEET_PIN, SCH_FIELD, and SCH_PIN.

Definition at line 478 of file eda_item.h.

{ return false; }

Schematic()

SCHEMATIC * SCH_SCREEN::Schematic

(

)

const

Definition at line 89 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(), IsTerminalPoint(), 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 40 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 53 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 66 of file inspectable.h.

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

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

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

        return object != nullptr;
    }

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

SetAuxOrigin()

void SCH_SCREEN::SetAuxOrigin ( const wxPoint &  aPosition )

inline

Definition at line 189 of file sch_screen.h.

{ m_aux_origin = aPosition; }

References m_aux_origin.

SetBrightened()

void EDA_ITEM::SetBrightened ( )

inlineinherited

Definition at line 197 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(), SELECTION_TOOL::highlightInternal(), and SCH_EDITOR_CONTROL::UpdateNetHighlighting().

SetFileName()

void SCH_SCREEN::SetFileName ( const wxString &  aFileName )

inline

Definition at line 184 of file sch_screen.h.

{ m_fileName = aFileName; }

References m_fileName.

Referenced by SCH_EDIT_FRAME::CreateScreens(), SCH_EDIT_FRAME::doAutoSave(), 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(), CADSTAR_SCH_ARCHIVE_LOADER::loadSheets(), DIALOG_SHEET_PROPERTIES::onSheetFilenameChanged(), SCH_EDIT_FRAME::OpenProjectFiles(), SCH_EDIT_FRAME::SaveEEFile(), and SCH_EDIT_FRAME::SaveProject().

SetFlags()

void EDA_ITEM::SetFlags ( STATUS_FLAGS  aMask )

inlineinherited

Definition at line 220 of file eda_item.h.

{ m_flags |= aMask; }

References EDA_ITEM::m_flags.

Referenced by SCH_EAGLE_PLUGIN::addBusEntries(), PCB_BASE_FRAME::AddFootprintToBoard(), SCH_MOVE_TOOL::AlignElements(), PCBNEW_CONTROL::AppendBoard(), FOOTPRINT::BuildPolyCourtyards(), SCH_EDIT_TOOL::ChangeTextType(), TRACKS_CLEANER::cleanup(), GRAPHICS_CLEANER::cleanupSegments(), ConvertOutlineToPolygon(), SCH_EDIT_FRAME::ConvertPart(), SCH_DRAWING_TOOLS::createNewText(), LIB_PIN_TOOL::CreatePin(), SCH_DRAWING_TOOLS::createSheetPin(), SCH_EDIT_TOOL::DoDelete(), SCH_LINE_WIRE_BUS_TOOL::doDrawSegments(), SCH_LINE_WIRE_BUS_TOOL::doUnfoldBus(), KIGFX::SCH_PAINTER::draw(), LIB_DRAWING_TOOLS::DrawShape(), SCH_DRAWING_TOOLS::DrawSheet(), SCH_EDIT_TOOL::Duplicate(), SCH_MOVE_TOOL::getConnectedDragItems(), SYMBOL_EDIT_FRAME::GetSymbolFromRedoList(), SYMBOL_EDIT_FRAME::GetSymbolFromUndoList(), EE_SELECTION_TOOL::Main(), EDIT_POINTS_FACTORY::Make(), TRACKS_CLEANER::mergeCollinearSegments(), LIB_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(), LIB_EDIT_TOOL::Paste(), SCH_EDITOR_CONTROL::Paste(), SCH_DRAWING_TOOLS::PlaceComponent(), SCH_DRAWING_TOOLS::PlaceImage(), PL_DRAWING_TOOLS::PlaceItem(), PCB_EDITOR_CONTROL::PlaceModule(), DRAWING_TOOL::PlaceText(), BACK_ANNOTATE::processNetNameChange(), SCH_EDIT_FRAME::PutDataInPreviousState(), SCH_EDIT_TOOL::RepeatDrawItem(), LIB_PIN_TOOL::RepeatPin(), DRC_TEST_PROVIDER_HOLE_CLEARANCE::Run(), SYMBOL_EDIT_FRAME::SaveCopyInUndoList(), EE_SELECTION_TOOL::selectMultiple(), 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(), WS_DATA_ITEM::SyncDrawItems(), WS_DATA_ITEM_TEXT::SyncDrawItems(), DIALOG_DIMENSION_PROPERTIES::TransferDataFromWindow(), DIALOG_TARGET_PROPERTIES::TransferDataFromWindow(), DIALOG_SYMBOL_PROPERTIES::TransferDataFromWindow(), DIALOG_TEXT_PROPERTIES::TransferDataFromWindow(), DIALOG_PAD_PROPERTIES::TransferDataFromWindow(), LIB_DRAWING_TOOLS::TwoClickPlace(), and SCH_DRAWING_TOOLS::TwoClickPlace().

SetForceVisible()

void EDA_ITEM::SetForceVisible ( bool  aEnable )

inlineinherited

Function SetForceVisible is used to set and cleag 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 272 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 79 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 LIB_PIN_TOOL::EditPinProperties(), LEGACY_PLUGIN::loadZONE_CONTAINER(), SCH_LINE::Move(), SCH_COMPONENT::Move(), SCH_LINE::MoveEnd(), SCH_LINE::MoveStart(), LIB_PIN::MoveTo(), PCB_EDIT_FRAME::OpenProjectFiles(), SCH_ALTIUM_PLUGIN::Parse(), ALTIUM_PCB::Parse(), LIB_PART::RemoveDrawItem(), SCH_COMPONENT::SetConvert(), SCH_COMPONENT::SetLibId(), EDA_ITEM::SetModified(), LIB_FIELD::SetName(), SCH_COMPONENT::SetTransform(), and SCH_COMPONENT::SetUnit().

SetModify()

void BASE_SCREEN::SetModify ( )

inlineinherited

Definition at line 120 of file base_screen.h.

{ m_flagModified = true; }

References BASE_SCREEN::m_flagModified.

Referenced by SCH_EDIT_FRAME::AddItemToScreenAndUndoList(), SCH_SHEET_LIST::BuildSheetList(), FOOTPRINT_EDITOR_TOOLS::CreateFootprint(), DeleteItem(), SCH_EDIT_FRAME::doAutoSave(), PCB_EDIT_FRAME::doAutoSave(), PL_EDITOR_FRAME::Files_io(), SCH_EDIT_FRAME::importFile(), SCH_EDIT_FRAME::InitSheet(), SCH_LEGACY_PLUGIN::loadComponent(), FOOTPRINT_EDITOR_TOOLS::NewFootprint(), SCH_EDIT_FRAME::OnModify(), PL_EDITOR_FRAME::OnModify(), SYMBOL_EDIT_FRAME::OnModify(), PCB_BASE_FRAME::OnModify(), DIALOG_PAGES_SETTINGS::OnOkClick(), SCH_EDIT_FRAME::OpenProjectFiles(), DIALOG_SYMBOL_REMAP::remapSymbolsToLibTable(), and SYMBOL_LIBRARY_MANAGER::UpdatePart().

SetPageCount()

void BASE_SCREEN::SetPageCount ( int  aPageCount )

inherited

Definition at line 71 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 144 of file base_screen.h.

{ m_pageNumber = aPageNumber; }

References BASE_SCREEN::m_pageNumber.

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

SetPageSettings()

void SCH_SCREEN::SetPageSettings ( const PAGE_INFO &  aPageSettings )

inline

Definition at line 182 of file sch_screen.h.

{ m_paper = aPageSettings; }

References m_paper.

Referenced by LIB_CONTROL::ExportSymbolAsSVG(), CADSTAR_SCH_ARCHIVE_LOADER::Load(), SCH_LEGACY_PLUGIN::loadPageSettings(), 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 DIMENSION_BASE.

Definition at line 184 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::addNewComponent(), SCH_SHEET::AddPin(), LIB_CONTROL::AddSymbolToSchematic(), Append(), LIB_FIELD::Copy(), SYMBOL_EDIT_FRAME::CreateNewPart(), SCH_DRAWING_TOOLS::createNewText(), DIALOG_PAD_PROPERTIES::DIALOG_PAD_PROPERTIES(), SCH_LINE_WIRE_BUS_TOOL::doUnfoldBus(), SCH_EDIT_TOOL::Duplicate(), PCB_EDIT_FRAME::ExchangeFootprint(), LIB_PART::Flatten(), FOOTPRINT::FOOTPRINT(), PCB_IO::FootprintSave(), DISPLAY_FOOTPRINTS_FRAME::GetFootprint(), LIB_PART::LIB_PART(), SCH_LEGACY_PLUGIN_CACHE::loadAliases(), FOOTPRINT_EDIT_FRAME::LoadFootprintFromBoard(), SCH_SEXPR_PLUGIN::loadHierarchy(), SCH_LEGACY_PLUGIN::loadHierarchy(), SYMBOL_EDIT_FRAME::LoadOneSymbol(), FOOTPRINT::operator=(), LIB_PART::operator=(), PCB_PARSER::parseFOOTPRINT_unchecked(), SCH_SEXPR_PARSER::ParseSchematic(), SCH_SEXPR_PARSER::ParseSymbol(), LIB_EDIT_TOOL::Paste(), PCBNEW_CONTROL::Paste(), SCH_EDITOR_CONTROL::Paste(), pasteFootprintItemsToFootprintEditor(), SCH_DRAWING_TOOLS::PlaceComponent(), PCB_EDITOR_CONTROL::PlaceModule(), 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_PART::SetFields(), DIMENSION_BASE::SetParent(), SCH_DRAWING_TOOLS::SingleClickPlace(), SCH_LINE_WIRE_BUS_TOOL::startSegments(), SCH_GLOBALLABEL::SwapData(), SCH_SHEET::SwapData(), SCH_COMPONENT::SwapData(), and SwapItemData().

SetPosition()

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

inlinevirtualinherited

Reimplemented in SCH_COMPONENT, SCH_SHEET, VIA, DELETED_BOARD_ITEM, WS_DRAW_ITEM_BITMAP, BOARD, SCH_TEXT, WS_DRAW_ITEM_TEXT, ARC, WS_DRAW_ITEM_PAGE, LIB_PIN, LIB_ITEM, SCH_LINE, WS_DRAW_ITEM_RECT, SCH_SHEET_PIN, FOOTPRINT, GERBER_DRAW_ITEM, SCH_FIELD, WS_DRAW_ITEM_POLYPOLYGONS, PAD, SCH_BITMAP, WS_DRAW_ITEM_LINE, PCB_SHAPE, DIMENSION_BASE, NETINFO_ITEM, ZONE, SCH_BUS_ENTRY_BASE, PCB_GROUP, SCH_NO_CONNECT, SCH_MARKER, TRACK, SCH_JUNCTION, KIGFX::ORIGIN_VIEWITEM, SCH_PIN, FP_TEXT, PCB_TEXT, DELETED_SHEET_ITEM, PCB_MARKER, and PCB_TARGET.

Definition at line 326 of file eda_item.h.

{};

Referenced by PCB_EDITOR_CONTROL::DoSetDrillOrigin(), PCBNEW_CONTROL::DoSetGridOrigin(), DRAWING_TOOL::DrawVia(), FOOTPRINT::GetFpPadsLocalBbox(), ALTIUM_PCB::ParseTexts6Data(), PL_DRAWING_TOOLS::PlaceItem(), DRAWING_TOOL::PlaceText(), PCB_BASE_EDIT_FRAME::PutDataInPreviousState(), BOARD_ITEM::SetX(), BOARD_ITEM::SetY(), SCH_DRAWING_TOOLS::SingleClickPlace(), and SCH_DRAWING_TOOLS::TwoClickPlace().

SetSave()

void BASE_SCREEN::SetSave ( )

inlineinherited

Definition at line 122 of file base_screen.h.

{ m_flagSave = true; }

References BASE_SCREEN::m_flagSave.

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

SetSelected()

void EDA_ITEM::SetSelected ( )

inlineinherited

Definition at line 196 of file eda_item.h.

{ SetFlags( SELECTED ); }

References SELECTED, and EDA_ITEM::SetFlags().

Referenced by KIGFX::SCH_PAINTER::draw(), PL_SELECTION_TOOL::highlight(), EE_SELECTION_TOOL::highlight(), SELECTION_TOOL::highlightInternal(), WS_PROXY_UNDO_ITEM::Restore(), EE_TOOL_BASE< SCH_BASE_FRAME >::saveCopyInUndoList(), GERBVIEW_SELECTION_TOOL::selectVisually(), and GROUP_TOOL::Ungroup().

SetState()

void EDA_ITEM::SetState ( int  type, int  state  )

inlineinherited

Definition at line 209 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(), SELECTION_TOOL::selectConnectedTracks(), and TRACK::SetLocked().

SetStatus()

void EDA_ITEM::SetStatus ( STATUS_FLAGS  aStatus )

inlineinherited

Definition at line 218 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 193 of file sch_screen.h.

{ m_titles = aTitleBlock; }

References m_titles.

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

SetVirtualPageNumber()

void BASE_SCREEN::SetVirtualPageNumber ( int  aPageNumber )

inlineinherited

Definition at line 141 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 195 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

Function Sort is a 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 509 of file eda_item.h.

{ return *aLeft < *aRight; }

TestDanglingEnds()

bool SCH_SCREEN::TestDanglingEnds

(

const SCH_SHEET_PATH *

aPath = nullptr

)

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

Returns

True if any connection state changes were made.

Definition at line 1004 of file sch_screen.cpp.

{
    std::vector< DANGLING_END_ITEM > endPoints;
    bool hasStateChanged = false;

    for( SCH_ITEM* item : Items() )
        item->GetEndPoints( endPoints );

    for( SCH_ITEM* item : Items() )
    {
        if( item->UpdateDanglingState( endPoints, aPath ) )
            hasStateChanged = true;
    }

    return hasStateChanged;
}

References Items().

Referenced by SCH_EDIT_FRAME::importFile(), and SCH_EDIT_FRAME::OpenProjectFiles().

Type()

KICAD_T EDA_ITEM::Type ( ) const

inlineinherited

Function Type()

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

Returns

KICAD_T - the type of object.

Definition at line 181 of file eda_item.h.

{ return m_structType; }

References EDA_ITEM::m_structType.

Referenced by FOOTPRINT::Add(), CN_CONNECTIVITY_ALGO::Add(), BOARD::Add(), CN_CLUSTER::Add(), 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(), CONNECTION_GRAPH::buildConnectionGraph(), DIALOG_NET_INSPECTOR::buildNewItem(), SCH_SCREENS::buildScreenList(), calcArea(), calcMaxArea(), PCB_INSPECTION_TOOL::calculateSelectionRatsnest(), POINT_EDITOR::canAddCorner(), SCH_JUNCTION::CanConnect(), SCH_NO_CONNECT::CanConnect(), SCH_BUS_WIRE_ENTRY::CanConnect(), SCH_BUS_BUS_ENTRY::CanConnect(), SCH_LINE::CanConnect(), SCH_LABEL::CanConnect(), SCH_GLOBALLABEL::CanConnect(), SCH_HIERLABEL::CanConnect(), SCH_SHEET::CanConnect(), SCH_COMPONENT::CanConnect(), ROUTER_TOOL::CanInlineDrag(), SCH_EDIT_TOOL::ChangeTextType(), CN_VISITOR::checkZoneItemConnection(), SCH_MARKER::ClassOf(), PCB_TEXT::ClassOf(), PCB_MARKER::ClassOf(), SCH_JUNCTION::ClassOf(), FP_SHAPE::ClassOf(), SCH_NO_CONNECT::ClassOf(), BOARD_CONNECTED_ITEM::ClassOf(), PCB_GROUP::ClassOf(), PCB_TARGET::ClassOf(), SCH_PIN::ClassOf(), SCH_LINE::ClassOf(), FP_TEXT::ClassOf(), SCH_FIELD::ClassOf(), PCB_SHAPE::ClassOf(), ZONE::ClassOf(), PAD::ClassOf(), SCH_BITMAP::ClassOf(), TRACK::ClassOf(), NETINFO_ITEM::ClassOf(), SCH_SHEET_PIN::ClassOf(), FOOTPRINT::ClassOf(), SCH_BUS_WIRE_ENTRY::ClassOf(), SCH_COMPONENT::ClassOf(), ClassOf(), SCH_BUS_BUS_ENTRY::ClassOf(), SCH_TEXT::ClassOf(), BOARD::ClassOf(), SCH_SHEET::ClassOf(), ARC::ClassOf(), SCH_LABEL::ClassOf(), ALIGNED_DIMENSION::ClassOf(), VIA::ClassOf(), SCH_GLOBALLABEL::ClassOf(), ORTHOGONAL_DIMENSION::ClassOf(), SCH_HIERLABEL::ClassOf(), LEADER::ClassOf(), CENTER_DIMENSION::ClassOf(), TRACKS_CLEANER::cleanup(), LIB_BEZIER::compare(), LIB_CIRCLE::compare(), LIB_RECTANGLE::compare(), LIB_TEXT::compare(), LIB_POLYLINE::compare(), LIB_ARC::compare(), LIB_FIELD::compare(), LIB_PIN::compare(), LIB_ITEM::compare(), EE_GRID_HELPER::computeAnchors(), GRID_HELPER::computeAnchors(), SCH_BUS_WIRE_ENTRY::ConnectionPropagatesTo(), EE_RTREE::contains(), BOARD::ConvertKIIDsToCrossReferences(), SCHEMATIC::ConvertKIIDsToRefs(), PAD_TOOL::copyPadSettings(), FOOTPRINT::CoverageRatio(), BOARD_ADAPTER::createLayers(), PCB_BASE_FRAME::CreateNewFootprint(), SCH_DRAWING_TOOLS::createNewText(), BOARD_ADAPTER::createNewTrack(), ZONE_CREATE_HELPER::createNewZone(), DeleteItem(), DIALOG_DIMENSION_PROPERTIES::DIALOG_DIMENSION_PROPERTIES(), DIALOG_LABEL_EDITOR::DIALOG_LABEL_EDITOR(), DIALOG_SCH_EDIT_ONE_FIELD::DIALOG_SCH_EDIT_ONE_FIELD(), DIALOG_TEXT_PROPERTIES::DIALOG_TEXT_PROPERTIES(), 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(), KIGFX::SCH_PAINTER::draw(), KIGFX::GERBVIEW_PAINTER::Draw(), KIGFX::PCB_PAINTER::Draw(), DRAWING_TOOL::DrawDimension(), CN_ITEM::Dump(), EDIT_TOOL::Duplicate(), FOOTPRINT::DuplicateItem(), EDA_ITEM_DESC::EDA_ITEM_DESC(), SCH_EDIT_TOOL::EditField(), SCH_EDIT_TOOL::editFieldText(), LIB_EDIT_TOOL::editTextProperties(), EditToolSelectionFilter(), CONNECTION_GRAPH::ercCheckBusToBusEntryConflicts(), CONNECTION_GRAPH::ercCheckFloatingWires(), CONNECTION_GRAPH::ercCheckLabels(), CONNECTION_GRAPH::ercCheckNoConnects(), DRC_ENGINE::EvalRulesForItems(), EDIT_TOOL::FilletTracks(), NETLIST_EXPORTER_BASE::findNextSymbol(), PCB_BASE_FRAME::FocusOnItem(), EDIT_TOOL::FootprintFilter(), SCH_SEXPR_PLUGIN::Format(), SCH_LEGACY_PLUGIN::Format(), PCB_IO::Format(), PCB_IO::format(), FormatProbeItem(), FP_TEXT::FP_TEXT(), POINT_EDITOR::get45DegConstrainer(), CN_ITEM::GetAnchor(), BOARD_ITEM::GetBoard(), SCH_FIELD::GetBoundingBox(), TRACK::GetBoundingBox(), SCH_FIELD::GetCanonicalName(), KIGFX::GERBVIEW_RENDER_SETTINGS::GetColor(), KIGFX::PCB_RENDER_SETTINGS::GetColor(), SCH_MOVE_TOOL::getConnectedDragItems(), SCH_TEXT::GetConnectionPoints(), SCH_TEXT::GetContextualTextVars(), CONNECTION_GRAPH::getDefaultConnection(), getDrilledHoleShape(), CONNECTION_SUBGRAPH::GetDriverPriority(), SCH_TEXT::GetEndPoints(), PL_EDITOR_FRAME::GetLayoutFromRedoList(), PL_EDITOR_FRAME::GetLayoutFromUndoList(), SCH_FIELD::GetMenuImage(), DIMENSION_BASE::GetMsgPanelInfo(), SCH_TEXT::GetMsgPanelInfo(), SCH_FIELD::GetName(), CONNECTION_SUBGRAPH::GetNameForDriver(), CONNECTIVITY_DATA::GetNetItems(), LIB_PART::GetNextDrawItem(), PCB_SHAPE::GetParentFootprint(), LIB_PART::GetPin(), SCH_COMPONENT::GetPinPhysicalPosition(), SCH_FIELD::GetPosition(), getRect(), KIGFX::SCH_PAINTER::getRenderColor(), getShape(), PCB_TEXT::GetShownText(), SCH_FIELD::GetShownText(), SCH_TEXT::GetShownText(), CONVERT_TOOL::getStartEndPoints(), BOARD::GroupLegalOps(), SELECTION_TOOL::GuessSelectionCandidates(), EE_SELECTION_TOOL::GuessSelectionCandidates(), hash_fp_item(), EE_SELECTION_TOOL::highlight(), SELECTION_TOOL::highlightInternal(), PCB_INSPECTION_TOOL::HighlightItem(), PCB_INSPECTION_TOOL::highlightNet(), highlightNet(), SCH_EDIT_TOOL::Init(), ROUTER_TOOL::InlineBreakTrack(), ROUTER_TOOL::InlineDrag(), EE_RTREE::insert(), DRC_RTREE::Insert(), insideArea(), EE_COLLECTOR::Inspect(), GENERAL_COLLECTOR::Inspect(), PCB_INSPECTION_TOOL::InspectClearance(), PCB_INSPECTION_TOOL::InspectConstraints(), ARRAY_CREATOR::Invoke(), CN_ANCHOR::IsDangling(), SCH_LINE_WIRE_BUS_TOOL::IsDrawingLineWireOrBus(), CADSTAR_PCB_ARCHIVE_LOADER::isFootprint(), SCH_FIELD::IsHypertext(), isKeepoutZone(), isNetTie(), TRACK::IsNull(), PNS_KICAD_IFACE::IsOnLayer(), SCH_LINE::IsParallel(), SCH_FIELD::IsReplaceable(), IsTerminalPoint(), BOARD_ITEM::IsTrack(), itemIsIncludedByFilter(), SELECTION_TOOL::itemPassesFilter(), CONVERT_TOOL::LinesToPoly(), CLIPBOARD_IO::Load(), CADSTAR_SCH_ARCHIVE_LOADER::loadHierarchicalSheetPins(), EE_POINT_EDITOR::Main(), LIB_MOVE_TOOL::Main(), SCH_MOVE_TOOL::Main(), EE_SELECTION_TOOL::Main(), EDIT_POINTS_FACTORY::Make(), NETLIST_EXPORTER_XML::makeListOfNets(), 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(), APPEARANCE_CONTROLS::OnBoardItemAdded(), APPEARANCE_CONTROLS::OnBoardItemChanged(), APPEARANCE_CONTROLS::OnBoardItemRemoved(), FOOTPRINT_EDIT_FRAME::OnEditItemRequest(), PCB_EDIT_FRAME::OnEditItemRequest(), EDA_3D_CANVAS::OnMouseMove(), TRACK::cmp_tracks::operator()(), CN_VISITOR::operator()(), PCB_SHAPE::cmp_drawings::operator()(), BOARD_ITEM::ptr_cmp::operator()(), FOOTPRINT::cmp_drawings::operator()(), SCH_JUNCTION::operator<(), SCH_BUS_ENTRY_BASE::operator<(), SCH_FIELD::operator<(), SCH_LINE::operator<(), LIB_ITEM::operator<(), SCH_TEXT::operator<(), SCH_ITEM::operator<(), SCH_SHEET::operator<(), SCH_COMPONENT::operator<(), SCH_BITMAP::operator=(), SCH_SHEET::operator=(), SCH_COMPONENT::operator=(), PAD::PAD(), EDIT_TOOL::PadFilter(), BOARD_COMMIT::parentObject(), PCBNEW_CONTROL::Paste(), SCH_EDITOR_CONTROL::Paste(), DRAWING_TOOL::PlaceImportedGraphics(), SCH_FIELD::Plot(), Plot(), BRDITEMS_PLOTTER::PlotFootprintGraphicItem(), CONVERT_TOOL::PolyToLines(), SCH_FIELD::Print(), Print(), DIALOG_GLOBAL_EDIT_TRACKS_AND_VIAS::processItem(), BACK_ANNOTATE::processNetNameChange(), LIB_EDIT_TOOL::Properties(), SCH_EDIT_TOOL::Properties(), BOARD_COMMIT::Push(), PCB_BASE_EDIT_FRAME::PutDataInPreviousState(), SCH_EDIT_FRAME::PutDataInPreviousState(), SELECTION_TOOL::RebuildSelection(), SCH_CONNECTION::recacheName(), SCH_BASE_FRAME::RefreshSelection(), EE_RTREE::remove(), FOOTPRINT::Remove(), CN_CONNECTIVITY_ALGO::Remove(), Remove(), BOARD::Remove(), POINT_EDITOR::removeCorner(), POINT_EDITOR::removeCornerCondition(), LIB_PART::RemoveDrawItem(), SCH_SHEET::RemovePin(), SCH_EDIT_TOOL::RepeatDrawItem(), SCH_FIELD::Replace(), SCHEMATIC::ResolveCrossReference(), CONNECTION_SUBGRAPH::ResolveDrivers(), PCB_PARSER::resolveGroups(), WS_PROXY_UNDO_ITEM::Restore(), PL_EDITOR_FRAME::RollbackFromUndo(), SCH_EDIT_TOOL::Rotate(), DRC_TEST_PROVIDER_MATCHED_LENGTH::runInternal(), SCH_SEXPR_PLUGIN_CACHE::saveArc(), SCH_LEGACY_PLUGIN_CACHE::saveArc(), SCH_SEXPR_PLUGIN_CACHE::saveBezier(), SCH_LEGACY_PLUGIN_CACHE::saveBezier(), SCH_SEXPR_PLUGIN_CACHE::saveCircle(), SCH_LEGACY_PLUGIN_CACHE::saveCircle(), 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(), SCH_SEXPR_PLUGIN_CACHE::savePolyLine(), SCH_LEGACY_PLUGIN_CACHE::savePolyLine(), SCH_SEXPR_PLUGIN_CACHE::saveRectangle(), SCH_LEGACY_PLUGIN_CACHE::saveRectangle(), 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(), SELECTION_TOOL::select(), SELECTION_TOOL::Selectable(), EE_SELECTION_TOOL::Selectable(), SELECTION_TOOL::selectConnectedTracks(), SCH_FIELD::SetId(), ITEM_PICKER::SetItem(), SCH_FIELD::SetPosition(), DIALOG_LABEL_EDITOR::SetTitle(), PCB_EDIT_FRAME::SetTrackSegmentWidth(), BOARD_COMMIT::Stage(), SCH_JUNCTION::SwapData(), SCH_NO_CONNECT::SwapData(), SCH_BITMAP::SwapData(), PCB_TARGET::SwapData(), PCB_GROUP::SwapData(), SCH_SHEET_PIN::SwapData(), PCB_TEXT::SwapData(), SCH_FIELD::SwapData(), TRACK::SwapData(), ARC::SwapData(), ALIGNED_DIMENSION::SwapData(), ORTHOGONAL_DIMENSION::SwapData(), SCH_SHEET::SwapData(), LEADER::SwapData(), SCH_COMPONENT::SwapData(), VIA::SwapData(), CENTER_DIMENSION::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(), PCB_GROUP::TopLevelGroup(), DIALOG_LABEL_EDITOR::TransferDataFromWindow(), DIALOG_FIELDS_EDITOR_GLOBAL::TransferDataToWindow(), DIALOG_DIMENSION_PROPERTIES::TransferDataToWindow(), DIALOG_TEXT_PROPERTIES::TransferDataToWindow(), DIALOG_LABEL_EDITOR::TransferDataToWindow(), TRACK::TransformShapeWithClearanceToPolygon(), LIB_DRAWING_TOOLS::TwoClickPlace(), EE_SELECTION_TOOL::unhighlight(), SELECTION_TOOL::unhighlightInternal(), KIGFX::PCB_VIEW::Update(), SCH_TEXT::UpdateDanglingState(), DIALOG_DIMENSION_PROPERTIES::updateDimensionFromDialog(), DIALOG_SCH_EDIT_ONE_FIELD::UpdateField(), PL_POINT_EDITOR::updateItem(), 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::updatePastedInstances(), EE_POINT_EDITOR::updatePoints(), PL_POINT_EDITOR::updatePoints(), POINT_EDITOR::updatePoints(), PCB_BRIGHT_BOX::ViewDraw(), SCH_BUS_ENTRY_BASE::ViewGetLayers(), PCB_GROUP::Visit(), TRACK::Visit(), GERBER_DRAW_ITEM::Visit(), SCH_GLOBALLABEL::Visit(), SCH_SHEET::Visit(), DIALOG_GLOBAL_EDIT_TEXT_AND_GRAPHICS::visitItem(), PCB_GROUP::WithinScope(), and NETLIST_EXPORTER_CADSTAR::writeListOfNets().

Update()

void SCH_SCREEN::Update

(

SCH_ITEM *

aItem

)

Updates aItem's bounding box in the tree.

Parameters

aItem

Item that needs to be updated.

Definition at line 234 of file sch_screen.cpp.

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

References Append(), and Remove().

Referenced by CADSTAR_SCH_ARCHIVE_LOADER::Load().

UpdateLocalLibSymbolLinks()

void SCH_SCREEN::UpdateLocalLibSymbolLinks

(

)

Initialize the LIB_PART reference for each SCH_COMPONENT found in this schematic with the local project library symbols.

Definition at line 712 of file sch_screen.cpp.

{
    std::vector<SCH_COMPONENT*> symbols;

    for( auto item : Items().OfType( SCH_COMPONENT_T ) )
        symbols.push_back( static_cast<SCH_COMPONENT*>( item ) );

    for( auto 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_PART* libSymbol = nullptr;

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

        symbol->SetLibSymbol( libSymbol );

        m_rtree.insert( symbol );
    }
}

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

Referenced by SCH_SEXPR_PARSER::ParseSchematic().

UpdateSymbolLinks()

void SCH_SCREEN::UpdateSymbolLinks

(

REPORTER *

aReporter = nullptr

)

Initialize the LIB_PART reference for each SCH_COMPONENT 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

aReporter

Optional REPORTER object to write status and error messages into.

Definition at line 553 of file sch_screen.cpp.

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

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

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

    for( auto item : Items().OfType( SCH_COMPONENT_T ) )
        symbols.push_back( static_cast<SCH_COMPONENT*>( item ) );

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

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

    for( auto symbol : symbols )
    {
        LIB_PART* 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(),
                            symbol->GetLibId().Format().wx_str() );
                aReporter->ReportTail( msg, RPT_SEVERITY_INFO );
            }

            // Internal library symbols are already flattened so just make a copy.
            symbol->SetLibSymbol( new LIB_PART( *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." ),
                            symbol->GetLibId().Format().wx_str() );
                aReporter->ReportTail( msg, RPT_SEVERITY_WARNING );
            }

            continue;
        }

        // LIB_TABLE_BASE::LoadSymbol() throws an IO_ERROR if the 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(),
                                symbol->GetLibId().Format().wx_str() );
                    aReporter->ReportTail( msg, RPT_SEVERITY_ERROR );
                }
            }
        }

        if( !tmp && legacyLibs )
        {
            // If here, only the cache library should be loaded if the loaded schematic
            // is the legacy file format.
            wxCHECK2( legacyLibs->GetLibraryCount() == 1, continue );

            PART_LIB& legacyCacheLib = legacyLibs->at( 0 );

            // ...and 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(),
                            id );
                aReporter->ReportTail( msg, RPT_SEVERITY_WARNING );
            }

            tmp = legacyCacheLib.FindPart( 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_PART( *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(),
                            symbol->GetLibId().Format().wx_str() );
                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( auto symbol : symbols )
        Append( symbol );
}

References _, Append(), clearLibSymbols(), LIB_PART::Flatten(), PART_LIBS::GetLibraryCount(), LIB_TABLE::HasLibrary(), Items(), SYMBOL_LIB_TABLE::LoadSymbol(), m_libSymbols, SCHEMATIC::Prj(), REFERENCE_FIELD, Remove(), REPORTER::ReportTail(), RPT_SEVERITY_ERROR, RPT_SEVERITY_INFO, RPT_SEVERITY_WARNING, SCH_COMPONENT_T, Schematic(), VALUE_FIELD, and IO_ERROR::What().

ViewBBox()

const BOX2I EDA_ITEM::ViewBBox ( ) const

overridevirtualinherited

Function ViewBBox() returns the bounding box of the item covering all its layers.

Returns

BOX2I - the current bounding box

Implements KIGFX::VIEW_ITEM.

Reimplemented in PAD, FOOTPRINT, EDIT_POINTS, CENTER_DIMENSION, PCB_SHAPE, GERBER_DRAW_ITEM, DIMENSION_BASE, TRACK, FP_TEXT, KIGFX::WS_PROXY_VIEW_ITEM, ROUTER_PREVIEW_ITEM, PCB_MARKER, MY_DRAWING, KIGFX::ORIGIN_VIEWITEM, KIGFX::PREVIEW::CENTRELINE_RECT_ITEM, KIGFX::PREVIEW::TWO_POINT_ASSISTANT, KIGFX::PREVIEW::POLYGON_ITEM, KIGFX::PREVIEW::SELECTION_AREA, KIGFX::PREVIEW::RULER_ITEM, KIGFX::RATSNEST_VIEWITEM, BRIGHT_BOX, and KIGFX::PREVIEW::ARC_ASSISTANT.

Definition at line 206 of file eda_item.cpp.

{
    // Basic fallback
    return BOX2I( VECTOR2I( GetBoundingBox().GetOrigin() ),
                  VECTOR2I( GetBoundingBox().GetSize() ) );
}

References EDA_ITEM::GetBoundingBox().

Referenced by GERBVIEW_FRAME::GetDocumentExtents(), BRIGHT_BOX::ViewBBox(), DIMENSION_BASE::ViewBBox(), PCB_SHAPE::ViewBBox(), and BRIGHT_BOX::ViewDraw().

ViewDraw()

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

inlinevirtualinherited

Function ViewDraw() Draws the parts of the object belonging to layer aLayer.

viewDraw() is an alternative way for drawing objects if 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	current drawing layer
aView	pointer to the VIEW device we are drawing on

Reimplemented in EDIT_POINTS, KIGFX::WS_PROXY_VIEW_ITEM, ROUTER_PREVIEW_ITEM, KIGFX::VIEW_GROUP, KIGFX::PREVIEW::SELECTION_AREA, MY_DRAWING, KIGFX::PREVIEW::SIMPLE_OVERLAY_ITEM, KIGFX::VIEW_OVERLAY, KIGFX::PREVIEW::TWO_POINT_ASSISTANT, KIGFX::ORIGIN_VIEWITEM, BRIGHT_BOX, KIGFX::PREVIEW::ARC_ASSISTANT, KIGFX::PREVIEW::RULER_ITEM, KIGFX::RATSNEST_VIEWITEM, and PCB_BRIGHT_BOX.

Definition at line 117 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

Function ViewGetLayers() Returns 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[]	output layer index array
aCount	number of layer indices in aLayers[]

Implements KIGFX::VIEW_ITEM.

Reimplemented in PAD, FOOTPRINT, SCH_SHEET, EDIT_POINTS, VIA, BOARD_ITEM, SCH_ITEM, GERBER_DRAW_ITEM, TRACK, FP_TEXT, LIB_PART, LIB_ITEM, MY_DRAWING, ZONE, SCH_COMPONENT, SCH_LINE, PCB_GROUP, LIB_FIELD, KIGFX::WS_PROXY_VIEW_ITEM, ROUTER_PREVIEW_ITEM, SCH_BITMAP, PCB_MARKER, SCH_BUS_ENTRY_BASE, WS_DRAW_ITEM_BASE, SCH_NO_CONNECT, KIGFX::ORIGIN_VIEWITEM, KIGFX::PREVIEW::SIMPLE_OVERLAY_ITEM, LIB_TEXT, SCH_JUNCTION, BRIGHT_BOX, KIGFX::PREVIEW::TWO_POINT_ASSISTANT, SCH_MARKER, KIGFX::RATSNEST_VIEWITEM, KIGFX::PREVIEW::RULER_ITEM, and KIGFX::PREVIEW::ARC_ASSISTANT.

Definition at line 214 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

Function ViewGetLOD() Returns 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	current drawing layer
aView	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, VIA, GERBER_DRAW_ITEM, TRACK, FP_TEXT, ZONE, PCB_GROUP, and FP_SHAPE.

Definition at line 141 of file view_item.h.

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

Referenced by PNS_KICAD_IFACE::IsItemVisible(), KIGFX::VIEW::drawItem::operator()(), EE_GRID_HELPER::queryVisible(), GRID_HELPER::queryVisible(), and SELECTION_TOOL::Selectable().

viewPrivData()

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

inlineinherited

Definition at line 149 of file view_item.h.

    {
        return m_viewPrivData;
    }

References KIGFX::VIEW_ITEM::m_viewPrivData.

Referenced by KIGFX::VIEW::Add(), KIGFX::VIEW::drawItem::deferredDraw(), KIGFX::VIEW::draw(), KIGFX::VIEW::Hide(), KIGFX::VIEW::invalidateItem(), KIGFX::VIEW::IsVisible(), KIGFX::VIEW::OnDestroy(), KIGFX::queryVisitor< Container >::operator()(), KIGFX::VIEW::updateItemsColor::operator()(), KIGFX::VIEW::changeItemsDepth::operator()(), KIGFX::VIEW::drawItem::operator()(), KIGFX::VIEW::recacheItem::operator()(), KIGFX::VIEW::clearLayerCache::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

Function Visit 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_COMPONENT, FOOTPRINT, SCH_SHEET, LIB_PART, GERBER_FILE_IMAGE, SCH_GLOBALLABEL, GERBER_DRAW_ITEM, TRACK, PCB_GROUP, and GBR_LAYOUT.

Definition at line 107 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 120 of file sch_screen.h.

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

m_aux_origin

wxPoint SCH_SCREEN::m_aux_origin

private

Definition at line 113 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 95 of file base_screen.h.

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

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 108 of file sch_screen.h.

Referenced by GetClientSheetPaths().

m_DrawOrg

wxPoint BASE_SCREEN::m_DrawOrg

inherited

offsets for drawing the circuit on the screen

Definition at line 87 of file base_screen.h.

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

m_fileName

wxString SCH_SCREEN::m_fileName

private

Definition at line 97 of file sch_screen.h.

Referenced by GetFileName(), and SetFileName().

m_flags

STATUS_FLAGS EDA_ITEM::m_flags

protectedinherited

Definition at line 164 of file eda_item.h.

Referenced by EDA_ITEM::ClearFlags(), LIB_TEXT::Clone(), EDA_ITEM::GetEditFlags(), EDA_ITEM::GetFlags(), TRACK::GetMsgPanelInfoBase_Common(), SCH_LINE::GetSelectedPoints(), EDA_ITEM::HasFlag(), LIB_CIRCLE::HitTest(), LIB_BEZIER::HitTest(), LIB_ARC::HitTest(), LIB_POLYLINE::HitTest(), SCH_JUNCTION::HitTest(), LIB_ITEM::HitTest(), LIB_PIN::HitTest(), SCH_LINE::HitTest(), SCH_COMPONENT::HitTest(), ZONE::InitDataFromSrcInCopyCtor(), EDA_ITEM::IsBrightened(), SCH_ITEM::IsConnected(), EDA_ITEM::IsDragging(), EDA_ITEM::IsModified(), EDA_ITEM::IsMoving(), EDA_ITEM::IsNew(), EDA_ITEM::IsResized(), EDA_ITEM::IsSelected(), EDA_ITEM::IsWireImage(), EDA_ITEM::operator=(), PCB_SHAPE::PCB_SHAPE(), EDA_ITEM::SetFlags(), PCB_SHAPE::SwapData(), and WS_DRAW_ITEM_BASE::WS_DRAW_ITEM_BASE().

m_forceVisible

bool EDA_ITEM::m_forceVisible

protectedinherited

Definition at line 163 of file eda_item.h.

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

m_Initialized

bool BASE_SCREEN::m_Initialized

inherited

Definition at line 101 of file base_screen.h.

Referenced by BASE_SCREEN::BASE_SCREEN(), SCH_EDIT_FRAME::DisplayCurrentSheet(), SCH_EDIT_FRAME::importFile(), and SCH_EDIT_FRAME::OpenProjectFiles().

m_libSymbols

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

private

Library symbols required for this schematic.

Definition at line 123 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 89 of file base_screen.h.

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

m_modification_sync

int SCH_SCREEN::m_modification_sync

private

Definition at line 116 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 63 of file base_screen.h.

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

m_PageLayoutDescrFileName

wxString BASE_SCREEN::m_PageLayoutDescrFileName

staticinherited

the name of the page layout descr file, or emty to used the default pagelayout

Definition at line 84 of file base_screen.h.

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

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 81 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 111 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 162 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(), FP_TEXT::GetDrawRotation(), SCH_FIELD::GetMenuImage(), PCB_TEXT::GetMsgPanelInfo(), FP_SHAPE::GetMsgPanelInfo(), FP_TEXT::GetMsgPanelInfo(), DIMENSION_BASE::GetMsgPanelInfo(), PAD::GetMsgPanelInfo(), SCH_FIELD::GetName(), PAD::GetParent(), SCH_SHEET_PIN::GetParent(), BOARD_ITEM::GetParent(), LIB_ITEM::GetParent(), EDA_ITEM::GetParent(), PCB_SHAPE::GetParentFootprint(), SCH_FIELD::GetParentPosition(), SCH_FIELD::GetPosition(), SCH_FIELD::GetShownText(), SCH_TEXT::GetShownText(), LIB_FIELD::HitTest(), SCH_FIELD::IsHypertext(), SCH_FIELD::IsReplaceable(), LIB_ITEM::LIB_ITEM(), PCB_SHAPE::MakeEffectiveShapes(), SCH_FIELD::Matches(), LIB_FIELD::operator=(), EDA_ITEM::operator=(), PAD::PAD(), SCH_FIELD::Plot(), SCH_FIELD::Print(), SCH_FIELD::Replace(), SCH_COMPONENT::SCH_COMPONENT(), FP_SHAPE::SetDrawCoord(), FP_TEXT::SetDrawCoord(), PAD::SetDrawCoord(), SCH_FIELD::SetId(), FP_SHAPE::SetLocalCoord(), FP_TEXT::SetLocalCoord(), PAD::SetLocalCoord(), EDA_ITEM::SetModified(), EDA_ITEM::SetParent(), SCH_FIELD::SetPosition(), and PCB_SHAPE::SwapData().

m_refCount

int SCH_SCREEN::m_refCount

private

Definition at line 99 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 114 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 99 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 140 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 92 of file base_screen.h.

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

m_status

STATUS_FLAGS EDA_ITEM::m_status

protectedinherited

Definition at line 161 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_COMPONENT 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 139 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 112 of file sch_screen.h.

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

m_Uuid

const KIID EDA_ITEM::m_Uuid

inherited

Definition at line 151 of file eda_item.h.

Referenced by FIELDS_EDITOR_GRID_DATA_MODEL::AddColumn(), SCH_COMPONENT::AddHierarchicalReference(), RC_ITEM::AddItem(), SCH_EDIT_FRAME::AnnotateComponents(), FIELDS_EDITOR_GRID_DATA_MODEL::ApplyData(), SCH_SHEET_PATH::Cmp(), SCHEMATIC::ConvertRefsToKIIDs(), MICROWAVE_TOOL::createMicrowaveInductor(), DRAWING_TOOL::DrawVia(), BOARD_ITEM::Duplicate(), SCH_ITEM::Duplicate(), FOOTPRINT::Duplicate(), FOOTPRINT::DuplicateItem(), PAD_TOOL::EditPad(), PCB_EDIT_FRAME::ExchangeFootprint(), PAD_TOOL::explodePad(), BOARD::FillItemMap(), SCH_SHEET_LIST::FillItemMap(), PCB_BASE_FRAME::FocusOnItem(), SCH_EDIT_FRAME::FocusOnItem(), PCB_IO::format(), FormatProbeItem(), SCH_PIN::GetDefaultNetName(), BOARD::GetItem(), SCH_SHEET_LIST::GetItem(), DIALOG_BOARD_REANNOTATE::GetNewRefDes(), SCH_REFERENCE::GetPath(), SCH_MARKER::GetUUID(), PCB_MARKER::GetUUID(), FIELDS_EDITOR_GRID_DATA_MODEL::groupMatch(), SCH_LEGACY_PLUGIN::loadComponent(), CADSTAR_PCB_ARCHIVE_LOADER::loadComponents(), LEGACY_PLUGIN::loadFOOTPRINT(), FOOTPRINT_EDIT_FRAME::LoadFootprintFromBoard(), PCB_EDIT_FRAME::LoadFootprints(), LEGACY_PLUGIN::loadPCB_TARGET(), LEGACY_PLUGIN::loadPCB_TEXT(), CADSTAR_SCH_ARCHIVE_LOADER::loadSchematicSymbol(), LEGACY_PLUGIN::loadTrackList(), NETLIST_EXPORTER_XML::makeSymbols(), SCH_EDIT_FRAME::mapExistingAnnotation(), TRACK::cmp_tracks::operator()(), PCB_SHAPE::cmp_drawings::operator()(), BOARD_ITEM::ptr_cmp::operator()(), FOOTPRINT::cmp_drawings::operator()(), FOOTPRINT::cmp_pads::operator()(), SCH_ITEM::operator<(), SCH_COMPONENT::operator<(), PAD::PAD(), PCB_PARSER::parseDIMENSION(), PCB_PARSER::parseFOOTPRINT_unchecked(), SCH_EDITOR_CONTROL::Paste(), SCH_SHEET_PATH::PathAsString(), SCH_SCREENS::ReplaceDuplicateTimeStamps(), SCH_COMPONENT::ReplaceInstanceSheetPath(), PCB_PARSER::resolveGroups(), SCH_LEGACY_PLUGIN::saveComponent(), FOOTPRINT_EDIT_FRAME::SaveFootprintToBoard(), SCH_EDIT_FRAME::SaveProject(), SCH_SEXPR_PLUGIN::saveSheet(), SCH_LEGACY_PLUGIN::saveSheet(), SCH_SEXPR_PLUGIN::saveSymbol(), SCH_COMPONENT::SCH_COMPONENT(), SCH_REFERENCE::SCH_REFERENCE(), SCH_SHEET::SCH_SHEET(), RC_ITEM::SetItems(), SwapItemData(), DRC_TEST_PROVIDER_EDGE_CLEARANCE::testAgainstEdge(), testGroupEqual(), SCH_EDITOR_CONTROL::updatePastedInstances(), and NETLIST_EXPORTER_ORCADPCB2::WriteNetlist().

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 71 of file base_screen.h.

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

SCH_EDIT_FRAME

friend SCH_SCREEN::SCH_EDIT_FRAME

private

Definition at line 142 of file sch_screen.h.

SCH_SEXPR_PARSER

friend SCH_SCREEN::SCH_SEXPR_PARSER

private

Definition at line 143 of file sch_screen.h.

SCH_SEXPR_PLUGIN

friend SCH_SCREEN::SCH_SEXPR_PLUGIN

private

Definition at line 144 of file sch_screen.h.

---

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

• sch_screen.h
• sch_screen.cpp