Sheet symbol placed in a schematic, and is the entry point for a sub schematic. More...

#include <sch_sheet.h>

Inheritance diagram for SCH_SHEET:

Public Member Functions
	SCH_SHEET (EDA_ITEM *aParent=nullptr, const VECTOR2I &aPos=VECTOR2I(0, 0), wxSize aSize=wxSize(schIUScale.MilsToIU(MIN_SHEET_WIDTH), schIUScale.MilsToIU(MIN_SHEET_HEIGHT)), FIELDS_AUTOPLACED aAutoplaceFields=FIELDS_AUTOPLACED_AUTO)

	SCH_SHEET (const SCH_SHEET &aSheet)
	Copy aSheet into a new object. More...

	~SCH_SHEET ()

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

bool	IsMovableFromAnchorPoint () const override
	Return true for items which are moved with the anchor point at mouse cursor and false for items moved with no reference to anchor. More...

std::vector< SCH_FIELD > &	GetFields ()

const std::vector< SCH_FIELD > &	GetFields () const

void	SetFields (const std::vector< SCH_FIELD > &aFields)
	Set multiple schematic fields. More...

wxString	GetName () const

SCH_SCREEN *	GetScreen () const

wxSize	GetSize () const

void	SetSize (const wxSize &aSize)

int	GetBorderWidth () const

void	SetBorderWidth (int aWidth)

KIGFX::COLOR4D	GetBorderColor () const

void	SetBorderColor (KIGFX::COLOR4D aColor)

KIGFX::COLOR4D	GetBackgroundColor () const

void	SetBackgroundColor (KIGFX::COLOR4D aColor)

bool	IsRootSheet () const

void	SetScreen (SCH_SCREEN *aScreen)
	Set the SCH_SCREEN associated with this sheet to aScreen. More...

int	GetScreenCount () const
	Return the number of times the associated screen for the sheet is being used. More...

void	GetContextualTextVars (wxArrayString *aVars) const
	Return the list of system text vars & fields for this sheet. More...

bool	ResolveTextVar (wxString *token, int aDepth=0) const
	Resolve any references to system tokens supported by the sheet. More...

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

bool	IsVerticalOrientation () const

void	AddPin (SCH_SHEET_PIN *aSheetPin)
	Add aSheetPin to the sheet. More...

std::vector< SCH_SHEET_PIN * > &	GetPins ()

const std::vector< SCH_SHEET_PIN * > &	GetPins () const

void	RemovePin (const SCH_SHEET_PIN *aSheetPin)
	Remove aSheetPin from the sheet. More...

void	CleanupSheet ()
	Delete sheet label which do not have a corresponding hierarchical label. More...

SCH_SHEET_PIN *	GetPin (const VECTOR2I &aPosition)
	Return the sheet pin item found at aPosition in the sheet. More...

bool	HasPin (const wxString &aName) const
	Checks if the sheet already has a sheet pin named aName. More...

bool	HasPins () const

bool	HasUndefinedPins () const
	Check all sheet labels against schematic for undefined hierarchical labels. More...

int	GetMinWidth (bool aFromLeft) const
	Return the minimum width of the sheet based on the widths of the sheet pin text. More...

int	GetMinHeight (bool aFromTop) const
	Return the minimum height that the sheet can be resized based on the sheet pin positions. More...

int	GetPenWidth () const override

void	Print (const RENDER_SETTINGS *aSettings, const VECTOR2I &aOffset) override
	Print a schematic item. More...

const BOX2I	GetBodyBoundingBox () const
	Return a bounding box for the sheet body but not the fields. More...

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

VECTOR2I	GetRotationCenter () const
	Rotating around the boundingBox's center can cause walking when the sheetname or filename is longer than the edge it's on. More...

void	SwapData (SCH_ITEM *aItem) override
	Swap the internal data structures aItem with the schematic item. More...

int	SymbolCount () const
	Count our own symbols, without the power symbols. More...

bool	SearchHierarchy (const wxString &aFilename, SCH_SCREEN **aScreen)
	Search the existing hierarchy for an instance of screen loaded from aFileName. More...

bool	LocatePathOfScreen (SCH_SCREEN aScreen, SCH_SHEET_PATH aList)
	Search the existing hierarchy for an instance of screen loaded from aFileName. More...

int	CountSheets () const
	Count the number of sheets found in "this" sheet including all of the subsheets. More...

wxString	GetFileName () const
	Return the filename corresponding to this sheet. More...

void	SetFileName (const wxString &aFilename)

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

void	MirrorHorizontally (int aCenter) override
	Mirror item horizontally about aCenter. More...

void	MirrorVertically (int aCenter) override
	Mirror item vertically about aCenter. More...

void	Rotate (const VECTOR2I &aCenter) override
	Rotate the item around aCenter 90 degrees in the clockwise direction. More...

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

bool	IsReplaceable () const override
	Override this method in any derived object that supports test find and replace. More...

void	Resize (const wxSize &aSize)
	Resize this sheet to aSize and adjust all of the labels accordingly. More...

void	AutoplaceFields (SCH_SCREEN *aScreen, bool aManual) override

void	GetEndPoints (std::vector< DANGLING_END_ITEM > &aItemList) override
	Add the schematic item end points to aItemList if the item has end points. More...

bool	UpdateDanglingState (std::vector< DANGLING_END_ITEM > &aItemList, const SCH_SHEET_PATH *aPath=nullptr) override
	Test the schematic item to aItemList to check if it's dangling state has changed. More...

bool	IsConnectable () const override

bool	CanConnect (const SCH_ITEM *aItem) const override

std::vector< VECTOR2I >	GetConnectionPoints () const override
	Add all the connection points for this item to aPoints. More...

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

void	RunOnChildren (const std::function< void(SCH_ITEM *)> &aFunction) override

wxString	GetSelectMenuText (UNITS_PROVIDER *aUnitsProvider) const override
	Return the text to display to be used in the selection clarification context menu when multiple items are found at the current cursor position. More...

BITMAPS	GetMenuImage () const override
	Return a pointer to an image to be used in menus. More...

SCH_SHEET &	operator= (const SCH_ITEM &aSheet)

bool	operator< (const SCH_ITEM &aItem) const override

void	ViewGetLayers (int aLayers[], int &aCount) const override
	Return the layers the item is drawn on (which may be more than its "home" layer) More...

VECTOR2I	GetPosition () const override

void	SetPosition (const VECTOR2I &aPosition) override

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

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

void	Plot (PLOTTER *aPlotter, bool aBackground) const override
	Plot the schematic item to aPlotter. More...

EDA_ITEM *	Clone () const override
	Create a duplicate of this item with linked list members set to NULL. More...

const std::vector< SCH_SHEET_INSTANCE > &	GetInstances () const

void	SetInstances (const std::vector< SCH_SHEET_INSTANCE > &aInstances)

bool	AddInstance (const SCH_SHEET_PATH &aInstance)
	Add a new instance aSheetPath to the instance list. More...

wxString	GetPageNumber (const SCH_SHEET_PATH &aInstance) const
	Return the sheet page number for aInstance. More...

void	SetPageNumber (const SCH_SHEET_PATH &aInstance, const wxString &aPageNumber)
	Set the page number for the sheet instance aInstance. More...

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

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

VECTOR2I &	GetStoredPos ()

void	SetStoredPos (const VECTOR2I &aPos)

SCHEMATIC *	Schematic () const
	Searches the item hierarchy to find a SCHEMATIC. More...

virtual bool	IsLocked () const

virtual void	SetLocked (bool aLocked)
	Set the 'lock' status to aLocked for of this item. More...

virtual bool	IsHypertext () const
	Allow items to support hypertext actions when hovered/clicked. More...

virtual void	DoHypertextAction (EDA_DRAW_FRAME *aFrame) const

SCH_LAYER_ID	GetLayer () const
	Return the layer this item is on. More...

void	SetLayer (SCH_LAYER_ID aLayer)
	Set the layer this item is on. More...

const wxString &	GetDefaultFont () const

bool	RenderAsBitmap (double aWorldScale) const override

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

virtual bool	IsDangling () const

virtual bool	IsPointClickableAnchor (const VECTOR2I &aPos) const

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

bool	IsConnected (const VECTOR2I &aPoint) const
	Test the item to see if it is connected to aPoint. More...

SCH_CONNECTION *	Connection (const SCH_SHEET_PATH *aSheet=nullptr) const
	Retrieve the connection associated with this object in the given sheet. More...

SCH_ITEM_SET &	ConnectedItems (const SCH_SHEET_PATH &aPath)
	Retrieve the set of items connected to this item on the given sheet. More...

void	AddConnectionTo (const SCH_SHEET_PATH &aPath, SCH_ITEM *aItem)
	Add a connection link between this item and another. More...

SCH_CONNECTION *	InitializeConnection (const SCH_SHEET_PATH &aPath, CONNECTION_GRAPH *aGraph)
	Create a new connection object associated with this object. More...

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

virtual bool	ConnectionPropagatesTo (const EDA_ITEM *aItem) const
	Return true if this item should propagate connection info to aItem. More...

bool	IsConnectivityDirty () const

void	SetConnectivityDirty (bool aDirty=true)

virtual void	SetLastResolvedState (const SCH_ITEM *aItem)

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

FIELDS_AUTOPLACED	GetFieldsAutoplaced () const
	Return whether the fields have been automatically placed. More...

void	SetFieldsAutoplaced ()

void	ClearFieldsAutoplaced ()

void	AutoAutoplaceFields (SCH_SCREEN *aScreen)
	Autoplace fields only if correct to do so automatically. More...

virtual void	ClearCaches ()

virtual bool	HasLineStroke () const
	Check if this schematic item has line stoke properties. More...

virtual STROKE_PARAMS	GetStroke () const

virtual void	SetStroke (const STROKE_PARAMS &aStroke)

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

KICAD_T	Type () const
	Returns the type of object. More...

EDA_ITEM *	GetParent () const

virtual void	SetParent (EDA_ITEM *aParent)

bool	IsModified () const

bool	IsNew () const

bool	IsMoving () const

bool	IsDragging () const

bool	IsWireImage () const

bool	IsSelected () const

bool	IsEntered () const

bool	IsResized () const

bool	IsBrightened () const

bool	IsRollover () const

void	SetWireImage ()

void	SetSelected ()

void	SetBrightened ()

void	ClearSelected ()

void	ClearBrightened ()

void	SetModified ()

int	GetState (EDA_ITEM_FLAGS type) const

void	SetState (EDA_ITEM_FLAGS type, bool state)

EDA_ITEM_FLAGS	GetStatus () const

void	SetStatus (EDA_ITEM_FLAGS aStatus)

void	SetFlags (EDA_ITEM_FLAGS aMask)

void	ClearFlags (EDA_ITEM_FLAGS aMask=EDA_ITEM_ALL_FLAGS)

EDA_ITEM_FLAGS	GetFlags () const

bool	HasFlag (EDA_ITEM_FLAGS aFlag) const

EDA_ITEM_FLAGS	GetEditFlags () const

void	ClearTempFlags ()

void	ClearEditFlags ()

void	SetIsShownAsBitmap (bool aBitmap)

bool	IsShownAsBitmap () const

void	SetForceVisible (bool aEnable)
	Set and clear force visible flag used to force the item to be drawn even if it's draw attribute is set to not visible. More...

bool	IsForceVisible () const

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

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

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

virtual bool	Replace (const EDA_SEARCH_DATA &aSearchData, void *aAuxData=nullptr)
	Perform a text replace using the find and replace criteria in aSearchData on items that support text find and replace. More...

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

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

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

VIEW_ITEM_DATA *	viewPrivData () const

void	ClearViewPrivData ()

bool	Set (PROPERTY_BASE *aProperty, wxAny &aValue)

template<typename T >
bool	Set (PROPERTY_BASE *aProperty, T aValue)

template<typename T >
bool	Set (const wxString &aProperty, T aValue)

wxAny	Get (PROPERTY_BASE *aProperty) const

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

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

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

static int	ComparePageNum (const wxString &aPageNumberA, const wxString &aPageNumberB)
	Compares page numbers of schematic sheets. More...

static const wxString	GetDefaultFieldName (int aFieldNdx, bool aTranslated=true)

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

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

static bool	Replace (const EDA_SEARCH_DATA &aSearchData, wxString &aText)
	Perform a text replace on aText using the find and replace criteria in aSearchData on items that support text find and replace. More...

static bool	Sort (const EDA_ITEM aLeft, const EDA_ITEM aRight)
	Helper function to be used by the C++ STL sort algorithm for sorting a STL container of EDA_ITEM pointers. More...

Public Attributes
const KIID	m_Uuid

Protected Member Functions
void	renumberPins ()
	Renumber the sheet pins in the sheet. More...

SCH_SHEET_PATH	findSelf () const
	Get the sheetpath of this sheet. More...

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

Protected Attributes
SCH_LAYER_ID	m_layer

EDA_ITEMS	m_connections

FIELDS_AUTOPLACED	m_fieldsAutoplaced

VECTOR2I	m_storedPos

std::map< SCH_SHEET_PATH, SCH_ITEM_SET, SHEET_PATH_CMP >	m_connected_items
	Store pointers to other items that are connected to this one, per sheet. More...

std::unordered_map< SCH_SHEET_PATH, SCH_CONNECTION * >	m_connection_map
	Store connectivity information, per sheet. More...

bool	m_connectivity_dirty

EDA_ITEM_FLAGS	m_status

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

bool	m_forceVisible

EDA_ITEM_FLAGS	m_flags

Private Member Functions
bool	doIsConnected (const VECTOR2I &aPosition) const override
	Provide the object specific test to see if it is connected to aPosition. More...

Private Attributes
SCH_SCREEN *	m_screen

std::vector< SCH_SHEET_PIN * >	m_pins

std::vector< SCH_FIELD >	m_fields

VECTOR2I	m_pos

wxSize	m_size

int	m_borderWidth

KIGFX::COLOR4D	m_borderColor

KIGFX::COLOR4D	m_backgroundColor

std::vector< SCH_SHEET_INSTANCE >	m_instances

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

VIEW_ITEM_DATA *	m_viewPrivData

Friends
class	SCH_SHEET_PIN

Detailed Description

Sheet symbol placed in a schematic, and is the entry point for a sub schematic.

Definition at line 54 of file sch_sheet.h.

Constructor & Destructor Documentation

◆ SCH_SHEET() [1/2]

SCH_SHEET::SCH_SHEET	(	EDA_ITEM *	aParent = `nullptr`,
		const VECTOR2I &	aPos = `VECTOR2I( 0, 0 )`,
		wxSize	aSize = `wxSize( schIUScale.MilsToIU( MIN_SHEET_WIDTH ), schIUScale.MilsToIU( MIN_SHEET_HEIGHT ) )`,
		FIELDS_AUTOPLACED	aAutoplaceFields = `FIELDS_AUTOPLACED_AUTO`
	)

Definition at line 77 of file sch_sheet.cpp.

 :
 SCH_ITEM( aParent, SCH_SHEET_T )
{
 m_layer = LAYER_SHEET;
 m_pos = aPos;
 m_size = aSize;
 m_screen = nullptr;
 
 for( int i = 0; i < SHEET_MANDATORY_FIELDS; ++i )
 {
 m_fields.emplace_back( aPos, i, this, GetDefaultFieldName( i ) );
 m_fields.back().SetVisible( true );
 
 if( i == SHEETNAME )
 m_fields.back().SetLayer( LAYER_SHEETNAME );
 else if( i == SHEETFILENAME )
 m_fields.back().SetLayer( LAYER_SHEETFILENAME );
 else
 m_fields.back().SetLayer( LAYER_SHEETFIELDS );
 }
 
 m_fieldsAutoplaced = aAutoplaceFields;
 AutoAutoplaceFields( nullptr );
 
 m_borderWidth = 0;
 m_borderColor = COLOR4D::UNSPECIFIED;
 m_backgroundColor = COLOR4D::UNSPECIFIED;
}

References SCH_ITEM::AutoAutoplaceFields(), GetDefaultFieldName(), LAYER_SHEET, LAYER_SHEETFIELDS, LAYER_SHEETFILENAME, LAYER_SHEETNAME, m_backgroundColor, m_borderColor, m_borderWidth, m_fields, SCH_ITEM::m_fieldsAutoplaced, SCH_ITEM::m_layer, m_pos, m_screen, m_size, SHEET_MANDATORY_FIELDS, SHEETFILENAME, and SHEETNAME.

Referenced by Clone().

◆ SCH_SHEET() [2/2]

SCH_SHEET::SCH_SHEET ( const SCH_SHEET & aSheet )

Copy aSheet into a new object.

All sheet pins are copied as is except and the SCH_SHEET_PIN's #m_Parent pointers are set to the new copied parent object.

Definition at line 108 of file sch_sheet.cpp.

 :
 SCH_ITEM( aSheet )
{
 m_pos = aSheet.m_pos;
 m_size = aSheet.m_size;
 m_layer = aSheet.m_layer;
 const_cast<KIID&>( m_Uuid ) = aSheet.m_Uuid;
 m_fields = aSheet.m_fields;
 m_fieldsAutoplaced = aSheet.m_fieldsAutoplaced;
 m_screen = aSheet.m_screen;
 
 for( SCH_SHEET_PIN* pin : aSheet.m_pins )
 {
 m_pins.emplace_back( new SCH_SHEET_PIN( *pin ) );
 m_pins.back()->SetParent( this );
 }
 
 for( SCH_FIELD& field : m_fields )
 field.SetParent( this );
 
 m_borderWidth = aSheet.m_borderWidth;
 m_borderColor = aSheet.m_borderColor;
 m_backgroundColor = aSheet.m_backgroundColor;
 m_instances = aSheet.m_instances;
 
 if( m_screen )
 m_screen->IncRefCount();
}

References SCH_SCREEN::IncRefCount(), m_backgroundColor, m_borderColor, m_borderWidth, m_fields, SCH_ITEM::m_fieldsAutoplaced, m_instances, SCH_ITEM::m_layer, m_pins, m_pos, m_screen, m_size, EDA_ITEM::m_Uuid, pin, and SCH_SHEET_PIN.

◆ ~SCH_SHEET()

SCH_SHEET::~SCH_SHEET ( )

Definition at line 138 of file sch_sheet.cpp.

{
 // also, look at the associated sheet & its reference count
 // perhaps it should be deleted also.
 if( m_screen )
 {
 m_screen->DecRefCount();
 
 if( m_screen->GetRefCount() == 0 )
 delete m_screen;
 }
 
 // We own our pins; delete them
 for( SCH_SHEET_PIN* pin : m_pins )
 delete pin;
}

References SCH_SCREEN::DecRefCount(), SCH_SCREEN::GetRefCount(), m_pins, m_screen, and pin.

Member Function Documentation

◆ AddConnectionTo()

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

inherited

Add a connection link between this item and another.

Definition at line 193 of file sch_item.cpp.

{
 SCH_ITEM_SET& set = m_connected_items[ aSheet ];
 
 // The vector elements are small, so reserve 1k at a time to prevent re-allocations
 if( set.size() == set.capacity() )
 set.reserve( set.size() + 4096 );
 
 set.emplace_back( aItem );
}

References SCH_ITEM::m_connected_items.

Referenced by SCH_LABEL_BASE::UpdateDanglingState(), and CONNECTION_GRAPH::updateItemConnectivity().

◆ AddInstance()

bool SCH_SHEET::AddInstance ( const SCH_SHEET_PATH & aInstance )

Add a new instance aSheetPath to the instance list.

If aSheetPath does not already exist, it is added to the list. If already exists in the list, do nothing. Sheet instances allow for the sharing in complex hierarchies which allows for per instance data such as page number for sheets to stored.

Warning: The SCH_SHEET_PATH object must be a full hierarchical path which means the SCH_SHEET object at index 0 must be the root sheet. A partial sheet path will raise an assertion on debug builds and silently fail and return false on release builds.

Parameters

[in] aInstance is the SCH_SHEET_PATH of the sheet instance to the instance list.

Returns: false if the instance already exists, true if the instance was added.

Definition at line 1205 of file sch_sheet.cpp.

{
 wxCHECK( aSheetPath.IsFullPath(), false );
 
 for( const SCH_SHEET_INSTANCE& instance : m_instances )
 {
 // if aSheetPath is found, nothing to do:
 if( instance.m_Path == aSheetPath.Path() )
 return false;
 }
 
 wxLogTrace( traceSchSheetPaths, wxT( "Adding instance `%s` to sheet `%s`." ),
 aSheetPath.Path().AsString(),
 ( GetName().IsEmpty() ) ? wxT( "root" ) : GetName() );
 
 SCH_SHEET_INSTANCE instance;
 
 instance.m_Path = aSheetPath.Path();
 
 // This entry does not exist: add it with an empty page number.
 m_instances.emplace_back( instance );
 return true;
}

References KIID_PATH::AsString(), GetName(), SCH_SHEET_PATH::IsFullPath(), m_instances, SCH_SHEET_INSTANCE::m_Path, SCH_SHEET_PATH::Path(), and traceSchSheetPaths.

Referenced by SCH_SHEET_PATH::AddNewSheetInstances(), SCH_EDIT_FRAME::CreateScreens(), SCH_DRAWING_TOOLS::DrawSheet(), SCH_ALTIUM_PLUGIN::Load(), SCH_EAGLE_PLUGIN::loadSchematic(), CADSTAR_SCH_ARCHIVE_LOADER::loadSheetAndChildSheets(), CADSTAR_SCH_ARCHIVE_LOADER::loadSheets(), SCH_ALTIUM_PLUGIN::ParseHarnessConnector(), SCH_ALTIUM_PLUGIN::ParseSheetSymbol(), SCH_SHEET_LIST::SetInitialPageNumbers(), DIALOG_SHEET_PROPERTIES::TransferDataFromWindow(), SCH_EDITOR_CONTROL::updatePastedSheet(), and SCH_SHEET_LIST::UpdateSheetInstances().

◆ AddPin()

void SCH_SHEET::AddPin ( SCH_SHEET_PIN * aSheetPin )

Add aSheetPin to the sheet.

Note: Once a sheet pin is added to the sheet, it is owned by the sheet. Do not delete the sheet pin object or you will likely get a segfault when the sheet is destroyed.

Parameters

aSheetPin The sheet pin item to add to the sheet.

Definition at line 353 of file sch_sheet.cpp.

{
 wxASSERT( aSheetPin != nullptr );
 wxASSERT( aSheetPin->Type() == SCH_SHEET_PIN_T );
 
 aSheetPin->SetParent( this );
 m_pins.push_back( aSheetPin );
 renumberPins();
}

References m_pins, renumberPins(), SCH_SHEET_PIN_T, EDA_ITEM::SetParent(), and EDA_ITEM::Type().

Referenced by SCH_EDIT_FRAME::AddItemToScreenAndUndoList(), and CADSTAR_SCH_ARCHIVE_LOADER::loadHierarchicalSheetPins().

◆ AutoAutoplaceFields()

void SCH_ITEM::AutoAutoplaceFields ( SCH_SCREEN * aScreen )

inlineinherited

Autoplace fields only if correct to do so automatically.

Fields that have been moved by hand are not automatically placed.

Parameters

aScreen is the SCH_SCREEN associated with the current instance of the symbol.

Definition at line 436 of file sch_item.h.

 {
 if( GetFieldsAutoplaced() )
 AutoplaceFields( aScreen, GetFieldsAutoplaced() == FIELDS_AUTOPLACED_MANUAL );
 }

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

Referenced by DIALOG_CHANGE_SYMBOLS::processSymbol(), SCH_EDIT_TOOL::Properties(), SCH_EDIT_TOOL::Rotate(), SCH_SHEET(), SCH_EDIT_FRAME::SelectUnit(), and DIALOG_LABEL_PROPERTIES::TransferDataFromWindow().

◆ AutoplaceFields()

void SCH_SHEET::AutoplaceFields	(	SCH_SCREEN *	aScreen,
		bool	aManual
	)

overridevirtual

Reimplemented from SCH_ITEM.

Definition at line 590 of file sch_sheet.cpp.

{
 VECTOR2I textSize = m_fields[SHEETNAME].GetTextSize();
 int borderMargin = KiROUND( GetPenWidth() / 2.0 ) + 4;
 int margin = borderMargin + KiROUND( std::max( textSize.x, textSize.y ) * 0.5 );
 
 if( IsVerticalOrientation() )
 {
 m_fields[SHEETNAME].SetTextPos( m_pos + VECTOR2I( -margin, m_size.y ) );
 m_fields[ SHEETNAME ].SetHorizJustify( GR_TEXT_H_ALIGN_LEFT );
 m_fields[ SHEETNAME ].SetVertJustify( GR_TEXT_V_ALIGN_BOTTOM );
 m_fields[ SHEETNAME ].SetTextAngle( ANGLE_VERTICAL );
 }
 else
 {
 m_fields[SHEETNAME].SetTextPos( m_pos + VECTOR2I( 0, -margin ) );
 m_fields[ SHEETNAME ].SetHorizJustify( GR_TEXT_H_ALIGN_LEFT );
 m_fields[ SHEETNAME ].SetVertJustify( GR_TEXT_V_ALIGN_BOTTOM );
 m_fields[ SHEETNAME ].SetTextAngle( ANGLE_HORIZONTAL );
 }
 
 textSize = m_fields[ SHEETFILENAME ].GetTextSize();
 margin = borderMargin + KiROUND( std::max( textSize.x, textSize.y ) * 0.4 );
 
 if( IsVerticalOrientation() )
 {
 m_fields[SHEETFILENAME].SetTextPos( m_pos + VECTOR2I( m_size.x + margin, m_size.y ) );
 m_fields[ SHEETFILENAME ].SetHorizJustify( GR_TEXT_H_ALIGN_LEFT );
 m_fields[ SHEETFILENAME ].SetVertJustify( GR_TEXT_V_ALIGN_TOP );
 m_fields[ SHEETFILENAME ].SetTextAngle( ANGLE_VERTICAL );
 }
 else
 {
 m_fields[SHEETFILENAME].SetTextPos( m_pos + VECTOR2I( 0, m_size.y + margin ) );
 m_fields[ SHEETFILENAME ].SetHorizJustify( GR_TEXT_H_ALIGN_LEFT );
 m_fields[ SHEETFILENAME ].SetVertJustify( GR_TEXT_V_ALIGN_TOP );
 m_fields[ SHEETFILENAME ].SetTextAngle( ANGLE_HORIZONTAL );
 }
 
 m_fieldsAutoplaced = FIELDS_AUTOPLACED_AUTO;
}

References ANGLE_HORIZONTAL, ANGLE_VERTICAL, FIELDS_AUTOPLACED_AUTO, GetPenWidth(), GR_TEXT_H_ALIGN_LEFT, GR_TEXT_V_ALIGN_BOTTOM, GR_TEXT_V_ALIGN_TOP, IsVerticalOrientation(), KiROUND(), m_fields, SCH_ITEM::m_fieldsAutoplaced, m_pos, m_size, SHEETFILENAME, SHEETNAME, VECTOR2< T >::x, and VECTOR2< T >::y.

Referenced by PANEL_EESCHEMA_COLOR_SETTINGS::createPreviewItems(), SCH_DRAWING_TOOLS::DrawSheet(), SCH_EAGLE_PLUGIN::loadSheet(), CADSTAR_SCH_ARCHIVE_LOADER::loadSheetAndChildSheets(), Resize(), Rotate(), and EE_POINT_EDITOR::updateParentItem().

◆ CanConnect()

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

inlineoverridevirtual

Reimplemented from SCH_ITEM.

Definition at line 340 of file sch_sheet.h.

 {
 return ( aItem->Type() == SCH_LINE_T && aItem->GetLayer() == LAYER_WIRE )
 || ( aItem->Type() == SCH_LINE_T && aItem->GetLayer() == LAYER_BUS )
 || ( aItem->Type() == SCH_NO_CONNECT_T )
 || ( aItem->Type() == SCH_SYMBOL_T );
 }

References SCH_ITEM::GetLayer(), LAYER_BUS, LAYER_WIRE, SCH_LINE_T, SCH_NO_CONNECT_T, SCH_SYMBOL_T, and EDA_ITEM::Type().

◆ ClassOf()

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

inlinestatic

Definition at line 70 of file sch_sheet.h.

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

References SCH_SHEET_T, and EDA_ITEM::Type().

Referenced by CADSTAR_SCH_ARCHIVE_LOADER::loadNets().

◆ CleanupSheet()

void SCH_SHEET::CleanupSheet ( )

Delete sheet label which do not have a corresponding hierarchical label.

Note: Make sure you save a copy of the sheet in the undo list before calling CleanupSheet() otherwise any unreferenced sheet labels will be lost.

Definition at line 540 of file sch_sheet.cpp.

{
 std::vector<SCH_SHEET_PIN*> pins = m_pins;
 
 m_pins.clear();
 
 for( SCH_SHEET_PIN* pin : pins )
 {
 /* Search the schematic for a hierarchical label corresponding to this sheet label. */
 const SCH_HIERLABEL* HLabel = nullptr;
 
 for( SCH_ITEM* aItem : m_screen->Items().OfType( SCH_HIER_LABEL_T ) )
 {
 if( pin->GetText().CmpNoCase( static_cast<SCH_HIERLABEL*>( aItem )->GetText() ) == 0 )
 {
 HLabel = static_cast<SCH_HIERLABEL*>( aItem );
 break;
 }
 }
 
 if( HLabel )
 m_pins.push_back( pin );
 }
}

References EDA_TEXT::GetText(), SCH_SCREEN::Items(), m_pins, m_screen, EE_RTREE::OfType(), pin, and SCH_HIER_LABEL_T.

Referenced by SCH_EDIT_TOOL::CleanupSheetPins().

◆ ClearBrightened()

void EDA_ITEM::ClearBrightened ( )

inlineinherited

Definition at line 122 of file eda_item.h.

122{ ClearFlags( BRIGHTENED ); }

EDA_ITEM::ClearFlags

void ClearFlags(EDA_ITEM_FLAGS aMask=EDA_ITEM_ALL_FLAGS)

Definition: eda_item.h:143

BRIGHTENED

#define BRIGHTENED

item is drawn with a bright contour

Definition: eda_item_flags.h:66

References BRIGHTENED, and EDA_ITEM::ClearFlags().

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

◆ ClearCaches()

void SCH_ITEM::ClearCaches ( )

virtualinherited

Reimplemented in SCH_FIELD.

Definition at line 251 of file sch_item.cpp.

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

References SCH_ITEM::RunOnChildren(), and text.

◆ ClearConnections()

void SCH_ITEM::ClearConnections ( )

inlineinherited

Clears all of the connection items from the list.

The vector release method is used to prevent the item pointers from being deleted. Do not use the vector erase method on the connection list.

Definition at line 372 of file sch_item.h.

372{ m_connections.clear(); }

SCH_ITEM::m_connections

EDA_ITEMS m_connections

Definition: sch_item.h:492

References SCH_ITEM::m_connections.

◆ ClearEditFlags()

void EDA_ITEM::ClearEditFlags ( )

inlineinherited

Definition at line 160 of file eda_item.h.

 {
 ClearFlags( GetEditFlags() );
 }

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

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

◆ ClearFieldsAutoplaced()

void SCH_ITEM::ClearFieldsAutoplaced ( )

inlineinherited

Definition at line 427 of file sch_item.h.

427{ m_fieldsAutoplaced = FIELDS_AUTOPLACED_NO; }

FIELDS_AUTOPLACED_NO

@ FIELDS_AUTOPLACED_NO

Definition: sch_item.h:56

References FIELDS_AUTOPLACED_NO, and SCH_ITEM::m_fieldsAutoplaced.

Referenced by BOOST_AUTO_TEST_CASE(), SCH_EDIT_TOOL::Mirror(), SCH_MOVE_TOOL::moveItem(), SCH_LABEL_BASE::SCH_LABEL_BASE(), DIALOG_LABEL_PROPERTIES::TransferDataFromWindow(), DIALOG_SHEET_PROPERTIES::TransferDataFromWindow(), and DIALOG_SCH_FIELD_PROPERTIES::UpdateField().

◆ ClearFlags()

void EDA_ITEM::ClearFlags ( EDA_ITEM_FLAGS aMask = EDA_ITEM_ALL_FLAGS )

inlineinherited

Definition at line 143 of file eda_item.h.

143{ m_flags &= ~aMask; }

EDA_ITEM::m_flags

EDA_ITEM_FLAGS m_flags

Definition: eda_item.h:498

References EDA_ITEM::m_flags.

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

◆ ClearSelected()

void EDA_ITEM::ClearSelected ( )

inlineinherited

Definition at line 121 of file eda_item.h.

121{ ClearFlags( SELECTED ); }

SELECTED

#define SELECTED

Item was manually selected by the user.

Definition: eda_item_flags.h:48

References EDA_ITEM::ClearFlags(), and SELECTED.

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

◆ ClearTempFlags()

void EDA_ITEM::ClearTempFlags ( )

inlineinherited

Definition at line 155 of file eda_item.h.

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

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

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

◆ ClearViewPrivData()

void KIGFX::VIEW_ITEM::ClearViewPrivData ( )

inlineinherited

Definition at line 143 of file view_item.h.

 {
 m_viewPrivData = nullptr;
 }

References KIGFX::VIEW_ITEM::m_viewPrivData.

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

◆ Clone()

EDA_ITEM * SCH_SHEET::Clone ( ) const

overridevirtual

Create a duplicate of this item with linked list members set to NULL.

The default version will return NULL in release builds and likely crash the program. In debug builds, a warning message indicating the derived class has not implemented cloning. This really should be a pure virtual function. Due to the fact that there are so many objects derived from EDA_ITEM, the decision was made to return NULL until all the objects derived from EDA_ITEM implement cloning. Once that happens, this function should be made pure.

Returns: A clone of the item.

Reimplemented from EDA_ITEM.

Definition at line 156 of file sch_sheet.cpp.

{
 return new SCH_SHEET( *this );
}

References SCH_SHEET().

Referenced by SCH_DRAWING_TOOLS::DrawSheet().

◆ ComparePageNum()

int SCH_SHEET::ComparePageNum	(	const wxString &	aPageNumberA,
		const wxString &	aPageNumberB
	)

static

Compares page numbers of schematic sheets.

Returns: 0 if the page numbers are equal, -1 if aPageNumberA < aPageNumberB, 1 otherwise

Definition at line 1267 of file sch_sheet.cpp.

{
 if( aPageNumberA == aPageNumberB )
 return 0; // A == B
 
 // First sort numerically if the page numbers are integers
 long pageA, pageB;
 bool isIntegerPageA = aPageNumberA.ToLong( &pageA );
 bool isIntegerPageB = aPageNumberB.ToLong( &pageB );
 
 if( isIntegerPageA && isIntegerPageB )
 {
 if( pageA < pageB )
 return -1; //A < B
 else
 return 1; // A > B
 }
 
 // Numerical page numbers always before strings
 if( isIntegerPageA )
 return -1; //A < B
 else if( isIntegerPageB )
 return 1; // A > B
 
 // If not numeric, then sort as strings using natural sort
 int result = StrNumCmp( aPageNumberA, aPageNumberB );
 
 // Divide by zero bad.
 wxCHECK( result != 0, 0 );
 
 result = result / std::abs( result );
 
 return result;
}

References std::abs(), and StrNumCmp().

Referenced by SCH_SHEET_PATH::ComparePageNum().

◆ ConnectedItems()

SCH_ITEM_SET & SCH_ITEM::ConnectedItems ( const SCH_SHEET_PATH & aPath )

inherited

Retrieve the set of items connected to this item on the given sheet.

Definition at line 187 of file sch_item.cpp.

{
 return m_connected_items[ aSheet ];
}

References SCH_ITEM::m_connected_items.

Referenced by addConnections(), SCH_EDIT_FRAME::AddItemToScreenAndUndoList(), SCH_LINE::FindWireSegmentNetNameRecursive(), and DIALOG_GLOBAL_EDIT_TEXT_AND_GRAPHICS::visitItem().

◆ Connection()

SCH_CONNECTION * SCH_ITEM::Connection ( const SCH_SHEET_PATH * aSheet = nullptr ) const

inherited

Retrieve the connection associated with this object in the given sheet.

Note: The returned value can be nullptr.

Definition at line 146 of file sch_item.cpp.

{
 if( !IsConnectable() )
 return nullptr;
 
 wxCHECK_MSG( !IsConnectivityDirty(), nullptr,
 wxT( "Shouldn't be asking for connection if connectivity is dirty!" ) );
 
 if( !aSheet )
 aSheet = &Schematic()->CurrentSheet();
 
 auto it = m_connection_map.find( *aSheet );
 
 if( it == m_connection_map.end() )
 return nullptr;
 else
 return it->second;
}

References SCHEMATIC::CurrentSheet(), SCH_ITEM::IsConnectable(), SCH_ITEM::IsConnectivityDirty(), SCH_ITEM::m_connection_map, and SCH_ITEM::Schematic().

Referenced by CONNECTION_SUBGRAPH::Absorb(), CONNECTION_SUBGRAPH::AddItem(), CONNECTION_GRAPH::buildConnectionGraph(), KIGFX::SCH_PAINTER::draw(), CONNECTION_GRAPH::ercCheckBusToBusConflicts(), CONNECTION_GRAPH::ercCheckBusToBusEntryConflicts(), CONNECTION_GRAPH::GetBusesNeedingMigration(), SCH_ITEM::GetEffectiveNetClass(), SCH_BUS_ENTRY_BASE::GetMsgPanelInfo(), SCH_LABEL_BASE::GetMsgPanelInfo(), SCH_LINE::GetMsgPanelInfo(), SCH_PIN::GetMsgPanelInfo(), CONNECTION_SUBGRAPH::GetNetName(), SCH_ITEM::GetOrInitConnection(), highlightNet(), SCH_ITEM::InitializeConnection(), SCH_LABEL_BASE::Plot(), SCH_LINE::Plot(), SCH_TEXT::Plot(), SCH_LABEL_BASE::Print(), SCH_EDIT_FRAME::RecalculateConnections(), CONNECTION_SUBGRAPH::ResolveDrivers(), SCH_LABEL_BASE::ResolveTextVar(), DIALOG_GLOBAL_EDIT_TEXT_AND_GRAPHICS::TransferDataToWindow(), BUS_UNFOLD_MENU::update(), SCH_EDITOR_CONTROL::UpdateNetHighlighting(), and DIALOG_GLOBAL_EDIT_TEXT_AND_GRAPHICS::visitItem().

◆ ConnectionPropagatesTo()

virtual bool SCH_ITEM::ConnectionPropagatesTo ( const EDA_ITEM * aItem ) const

inlinevirtualinherited

Return true if this item should propagate connection info to aItem.

Reimplemented in SCH_BUS_WIRE_ENTRY, SCH_LINE, and SCH_PIN.

Definition at line 411 of file sch_item.h.

411{ return true; }

◆ CountSheets()

int SCH_SHEET::CountSheets ( ) const

Count the number of sheets found in "this" sheet including all of the subsheets.

Returns: the full count of sheets+subsheets contained by "this"

Definition at line 767 of file sch_sheet.cpp.

{
 int count = 1; //1 = this!!
 
 if( m_screen )
 {
 for( SCH_ITEM* aItem : m_screen->Items().OfType( SCH_SHEET_T ) )
 count += static_cast<SCH_SHEET*>( aItem )->CountSheets();
 }
 
 return count;
}

References CountSheets(), SCH_SCREEN::Items(), m_screen, EE_RTREE::OfType(), and SCH_SHEET_T.

Referenced by CountSheets(), SCH_PRINTOUT::GetPageInfo(), SCH_PRINTOUT::HasPage(), SCH_EDIT_FRAME::SetSheetNumberAndCount(), and DIALOG_PRINT_USING_PRINTER::TransferDataFromWindow().

◆ DoHypertextAction()

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

inlinevirtualinherited

Reimplemented in SCH_FIELD, SCH_TEXT, and SCH_TEXTBOX.

Definition at line 241 of file sch_item.h.

241{ }

◆ doIsConnected()

bool SCH_SHEET::doIsConnected ( const VECTOR2I & aPosition ) const

overrideprivatevirtual

Provide the object specific test to see if it is connected to aPosition.

Note: Override this function if the derived object can be connect to another object such as a wire, bus, or junction. Do not override this function for objects that cannot have connections. The default will always return false. This functions is call through the public function IsConnected() which performs tests common to all schematic items before calling the item specific connection testing.

Parameters

aPosition is a reference to a VECTOR2I object containing the test position.

Returns: True if connection to aPosition exists.

Reimplemented from SCH_ITEM.

Definition at line 393 of file sch_sheet.cpp.

{
 for( SCH_SHEET_PIN* sheetPin : m_pins )
 {
 if( sheetPin->GetPosition() == aPosition )
 return true;
 }
 
 return false;
}

References m_pins.

◆ Duplicate()

SCH_ITEM * SCH_ITEM::Duplicate ( bool doClone = false ) const

inherited

Routine to create a new copy of given item.

The new object is not put in draw list (not linked).

Parameters

doClone (default = false) indicates unique values (such as timestamp and sheet name) should be duplicated. Use only for undo/redo operations.

Definition at line 93 of file sch_item.cpp.

{
 SCH_ITEM* newItem = (SCH_ITEM*) Clone();
 
 if( !doClone )
 const_cast<KIID&>( newItem->m_Uuid ) = KIID();
 
 newItem->ClearFlags( SELECTED | BRIGHTENED );
 
 newItem->RunOnChildren(
 []( SCH_ITEM* aChild )
 {
 aChild->ClearFlags( SELECTED | BRIGHTENED );
 } );
 
 return newItem;
}

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

Referenced by SCH_EDIT_FRAME::BreakSegment(), SCH_LINE_WIRE_BUS_TOOL::doDrawSegments(), CADSTAR_SCH_ARCHIVE_LOADER::loadItemOntoKiCadSheet(), SCH_EAGLE_PLUGIN::loadSchematic(), SCH_DRAWING_TOOLS::PlaceSymbol(), SCH_EDIT_TOOL::RepeatDrawItem(), SCH_EDIT_FRAME::SaveCopyInUndoList(), and SCH_LINE_WIRE_BUS_TOOL::startSegments().

◆ findSelf()

SCH_SHEET_PATH SCH_SHEET::findSelf ( ) const

protected

Get the sheetpath of this sheet.

NB: REQUIRES that the current sheet hierarchy contains the given sheet.

Definition at line 935 of file sch_sheet.cpp.

{
 wxCHECK_MSG( Schematic(), SCH_SHEET_PATH(), "Can't call findSelf without a schematic" );
 
 SCH_SHEET_PATH sheetPath = Schematic()->CurrentSheet();
 
 while( !sheetPath.empty() && sheetPath.Last() != this )
 sheetPath.pop_back();
 
 if( sheetPath.empty() )
 {
 // If we weren't in the hierarchy, then we must be a child of the current sheet.
 sheetPath = Schematic()->CurrentSheet();
 sheetPath.push_back( const_cast<SCH_SHEET*>( this ) );
 }
 
 return sheetPath;
}

References SCHEMATIC::CurrentSheet(), SCH_SHEET_PATH::empty(), SCH_SHEET_PATH::Last(), SCH_SHEET_PATH::pop_back(), SCH_SHEET_PATH::push_back(), and SCH_ITEM::Schematic().

Referenced by GetContextualTextVars(), Plot(), and ResolveTextVar().

◆ Get() [1/3]

template<typename T >

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

inlineinherited

Definition at line 104 of file inspectable.h.

 {
 PROPERTY_MANAGER& propMgr = PROPERTY_MANAGER::Instance();
 TYPE_ID thisType = TYPE_HASH( *this );
 PROPERTY_BASE* prop = propMgr.GetProperty( thisType, aProperty );
 std::optional<T> ret;
 
 if( prop )
 {
 const void* object = propMgr.TypeCast( this, thisType, prop->OwnerHash() );
 
 if( object )
 ret = prop->get<T>( object );
 }
 
 return ret;
 }

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

◆ Get() [2/3]

wxAny INSPECTABLE::Get ( PROPERTY_BASE * aProperty ) const

inlineinherited

Definition at line 84 of file inspectable.h.

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

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

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

◆ Get() [3/3]

template<typename T >

T INSPECTABLE::Get ( PROPERTY_BASE * aProperty ) const

inlineinherited

Definition at line 92 of file inspectable.h.

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

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

◆ GetBackgroundColor()

KIGFX::COLOR4D SCH_SHEET::GetBackgroundColor ( ) const

inline

Definition at line 114 of file sch_sheet.h.

114{ return m_backgroundColor; }

References m_backgroundColor.

Referenced by KIGFX::SCH_PAINTER::getRenderColor(), Plot(), Print(), SCH_SEXPR_PLUGIN::saveSheet(), DIALOG_SHEET_PROPERTIES::TransferDataFromWindow(), and DIALOG_SHEET_PROPERTIES::TransferDataToWindow().

◆ GetBodyBoundingBox()

const BOX2I SCH_SHEET::GetBodyBoundingBox ( ) const

Return a bounding box for the sheet body but not the fields.

Definition at line 646 of file sch_sheet.cpp.

{
 VECTOR2I end;
 BOX2I box( m_pos, m_size );
 int lineWidth = GetPenWidth();
 int textLength = 0;
 
 // Calculate bounding box X size:
 end.x = std::max( m_size.x, textLength );
 
 // Calculate bounding box pos:
 end.y = m_size.y;
 end += m_pos;
 
 box.SetEnd( end );
 box.Inflate( lineWidth / 2 );
 
 return box;
}

References GetPenWidth(), BOX2< Vec >::Inflate(), m_pos, m_size, BOX2< Vec >::SetEnd(), VECTOR2< T >::x, and VECTOR2< T >::y.

Referenced by GetBoundingBox(), HitTest(), and SCH_EDIT_TOOL::Rotate().

◆ GetBorderColor()

KIGFX::COLOR4D SCH_SHEET::GetBorderColor ( ) const

inline

Definition at line 111 of file sch_sheet.h.

111{ return m_borderColor; }

References m_borderColor.

Referenced by KIGFX::SCH_PAINTER::getRenderColor(), Plot(), Print(), SCH_SEXPR_PLUGIN::saveSheet(), DIALOG_SHEET_PROPERTIES::TransferDataFromWindow(), and DIALOG_SHEET_PROPERTIES::TransferDataToWindow().

◆ GetBorderWidth()

int SCH_SHEET::GetBorderWidth ( ) const

inline

Definition at line 108 of file sch_sheet.h.

108{ return m_borderWidth; }

References m_borderWidth.

Referenced by GetPenWidth(), SCH_SEXPR_PLUGIN::saveSheet(), and DIALOG_SHEET_PROPERTIES::TransferDataToWindow().

◆ GetBoundingBox()

const BOX2I SCH_SHEET::GetBoundingBox ( ) const

overridevirtual

Return the orthogonal bounding box of this object for display purposes.

This box should be an enclosing perimeter for visible components of this object, and the units should be in the pcb or schematic coordinate system. It is OK to overestimate the size by a few counts.

Reimplemented from EDA_ITEM.

Definition at line 667 of file sch_sheet.cpp.

{
 BOX2I bbox = GetBodyBoundingBox();
 
 for( const SCH_FIELD& field : m_fields )
 bbox.Merge( field.GetBoundingBox() );
 
 return bbox;
}

References GetBodyBoundingBox(), m_fields, and BOX2< Vec >::Merge().

Referenced by SCH_EDIT_TOOL::Mirror(), and Plot().

◆ GetClass()

wxString SCH_SHEET::GetClass ( ) const

inlineoverridevirtual

Return the class name.

Reimplemented from SCH_ITEM.

Definition at line 75 of file sch_sheet.h.

 {
 return wxT( "SCH_SHEET" );
 }

Referenced by operator=().

◆ GetConnectionPoints()

std::vector< VECTOR2I > SCH_SHEET::GetConnectionPoints ( ) const

overridevirtual

Add all the connection points for this item to aPoints.

Not all schematic items have connection points so the default method does nothing.

Parameters

aPoints is the list of connection points to add to.

Reimplemented from SCH_ITEM.

Definition at line 979 of file sch_sheet.cpp.

{
 std::vector<VECTOR2I> retval;
 
 for( SCH_SHEET_PIN* sheetPin : m_pins )
 retval.push_back( sheetPin->GetPosition() );
 
 return retval;
}

References m_pins.

◆ GetContextualTextVars()

void SCH_SHEET::GetContextualTextVars ( wxArrayString * aVars ) const

Return the list of system text vars & fields for this sheet.

Definition at line 202 of file sch_sheet.cpp.

{
 auto add =
 [&]( const wxString& aVar )
 {
 if( !alg::contains( *aVars, aVar ) )
 aVars->push_back( aVar );
 };
 
 for( int i = 0; i < SHEET_MANDATORY_FIELDS; ++i )
 add( m_fields[i].GetCanonicalName().Upper() );
 
 for( size_t i = SHEET_MANDATORY_FIELDS; i < m_fields.size(); ++i )
 add( m_fields[i].GetName() );
 
 SCH_SHEET_PATH sheetPath = findSelf();
 
 if( sheetPath.size() >= 2 )
 {
 sheetPath.pop_back();
 sheetPath.Last()->GetContextualTextVars( aVars );
 }
 
 add( wxT( "#" ) );
 add( wxT( "##" ) );
 add( wxT( "SHEETPATH" ) );
 
 m_screen->GetTitleBlock().GetContextualTextVars( aVars );
}

References alg::contains(), findSelf(), TITLE_BLOCK::GetContextualTextVars(), GetContextualTextVars(), GetName(), SCH_SCREEN::GetTitleBlock(), SCH_SHEET_PATH::Last(), m_fields, m_screen, SCH_SHEET_PATH::pop_back(), SHEET_MANDATORY_FIELDS, and SCH_SHEET_PATH::size().

Referenced by GetContextualTextVars(), DIALOG_SCH_FIELD_PROPERTIES::onScintillaCharAdded(), and DIALOG_TEXT_PROPERTIES::onScintillaCharAdded().

◆ GetDefaultFieldName()

const wxString SCH_SHEET::GetDefaultFieldName	(	int	aFieldNdx,
		bool	aTranslated = `true`
	)

static

Definition at line 55 of file sch_sheet.cpp.

{
 if( !aTranslated )
 {
 switch( aFieldNdx )
 {
 case SHEETNAME: return SHEET_NAME_CANONICAL;
 case SHEETFILENAME: return SHEET_FILE_CANONICAL;
 default: return wxString::Format( USER_FIELD_CANONICAL, aFieldNdx );
 }
 }
 
 // Fixed values for the mandatory fields
 switch( aFieldNdx )
 {
 case SHEETNAME: return _( SHEET_NAME_CANONICAL );
 case SHEETFILENAME: return _( SHEET_FILE_CANONICAL );
 default: return wxString::Format( _( USER_FIELD_CANONICAL ), aFieldNdx );
 }
}

References _, Format(), SHEET_FILE_CANONICAL, SHEET_NAME_CANONICAL, SHEETFILENAME, SHEETNAME, and USER_FIELD_CANONICAL.

Referenced by SCH_FIELD::GetName(), FIELDS_GRID_TABLE< T >::GetValue(), DIALOG_SHEET_PROPERTIES::OnAddField(), SCH_SEXPR_PARSER::parseSchField(), and SCH_SHEET().

◆ GetDefaultFont()

const wxString & SCH_ITEM::GetDefaultFont ( ) const

inherited

Definition at line 286 of file sch_item.cpp.

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

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

Referenced by SCH_FIELD::GetDrawFont(), SCH_TEXT::GetDrawFont(), and SCH_TEXTBOX::GetDrawFont().

◆ GetEditFlags()

EDA_ITEM_FLAGS EDA_ITEM::GetEditFlags ( ) const

inlineinherited

Definition at line 147 of file eda_item.h.

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

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

◆ GetEffectiveNetClass()

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

inherited

Definition at line 166 of file sch_item.cpp.

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

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

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

◆ GetEndPoints()

void SCH_SHEET::GetEndPoints ( std::vector< DANGLING_END_ITEM > & aItemList )

overridevirtual

Add the schematic item end points to aItemList if the item has end points.

The default version doesn't do anything since many of the schematic object cannot be tested for dangling ends. If you add a new schematic item that can have a dangling end ( no connect ), override this method to provide the correct end points.

Parameters

aItemList is the list of DANGLING_END_ITEMS to add to.

Reimplemented from SCH_ITEM.

Definition at line 955 of file sch_sheet.cpp.

{
 for( SCH_SHEET_PIN* sheetPin : m_pins )
 {
 wxCHECK2_MSG( sheetPin->Type() == SCH_SHEET_PIN_T, continue,
 wxT( "Invalid item in schematic sheet pin list. Bad programmer!" ) );
 
 sheetPin->GetEndPoints( aItemList );
 }
}

References m_pins, and SCH_SHEET_PIN_T.

◆ GetFields() [1/2]

std::vector< SCH_FIELD > & SCH_SHEET::GetFields ( )

inline

◆ GetFields() [2/2]

const std::vector< SCH_FIELD > & SCH_SHEET::GetFields ( ) const

inline

Definition at line 92 of file sch_sheet.h.

92{ return m_fields; }

References m_fields.

◆ GetFieldsAutoplaced()

FIELDS_AUTOPLACED SCH_ITEM::GetFieldsAutoplaced ( ) const

inlineinherited

Return whether the fields have been automatically placed.

Definition at line 424 of file sch_item.h.

424{ return m_fieldsAutoplaced; }

References SCH_ITEM::m_fieldsAutoplaced.

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

◆ GetFileName()

wxString SCH_SHEET::GetFileName ( void ) const

inline

Return the filename corresponding to this sheet.

Returns: a wxString containing the filename

Definition at line 299 of file sch_sheet.h.

 {
 return m_fields[ SHEETFILENAME ].GetText();
 }

References m_fields, and SHEETFILENAME.

Referenced by SCH_SHEET_LIST::BuildSheetList(), SCH_EDIT_FRAME::doAutoSave(), SCH_EDITOR_CONTROL::doCopy(), SCH_ALTIUM_PLUGIN::getLibName(), SCH_EAGLE_PLUGIN::getLibName(), CADSTAR_SCH_ARCHIVE_PLUGIN::Load(), SCH_SEXPR_PLUGIN::Load(), SCH_LEGACY_PLUGIN::Load(), SCH_SEXPR_PLUGIN::loadHierarchy(), SCH_LEGACY_PLUGIN::loadHierarchy(), SCH_EDIT_FRAME::LoadSheetFromFile(), SCH_SHEET_PATH::MakeFilePathRelativeToParentSheet(), DIALOG_SCH_IMPORT_SETTINGS::OnBrowseClicked(), DIALOG_PLOT_SCHEMATIC::OnOutputDirectoryBrowseClicked(), DIALOG_SHEET_PROPERTIES::onSheetFilenameChanged(), SCH_EDITOR_CONTROL::Paste(), SCH_EDITOR_CONTROL::SaveCurrSheetCopyAs(), SCH_EDIT_FRAME::SaveProject(), SCH_SHEET_LIST::TestForRecursion(), and SCH_SHEET_PATH::TestForRecursion().

◆ GetFlags()

EDA_ITEM_FLAGS EDA_ITEM::GetFlags ( ) const

inlineinherited

Definition at line 144 of file eda_item.h.

144{ return m_flags; }

References EDA_ITEM::m_flags.

Referenced by BACK_ANNOTATE::applyChangelist(), collidesWithArea(), ConvertOutlineToPolygon(), SCH_EDIT_FRAME::ConvertPart(), KIGFX::PCB_PAINTER::draw(), KIGFX::SCH_PAINTER::draw(), DRC_ENGINE::EvalRules(), PCB_SELECTION_TOOL::FilterCollectorForHierarchy(), LIB_SYMBOL::LIB_SYMBOL(), BOARD_INSPECTION_TOOL::makeDRCEngine(), CONVERT_TOOL::makePolysFromChainedSegs(), DIALOG_DRC::OnDRCItemSelected(), DIALOG_FOOTPRINT_CHECKER::OnSelectItem(), DIALOG_SYMBOL_PROPERTIES::OnUnitChoice(), LIB_SYMBOL::operator=(), BOARD_COMMIT::Push(), PAD_TOOL::RecombinePad(), BOARD::Remove(), FOOTPRINT::Remove(), SCH_EDIT_FRAME::SaveCopyInUndoList(), SCH_EDIT_FRAME::SelectUnit(), DS_DATA_ITEM::SyncDrawItems(), DS_DATA_ITEM_POLYGONS::SyncDrawItems(), DS_DATA_ITEM_BITMAP::SyncDrawItems(), CONNECTIVITY_DATA::TestTrackEndpointDangling(), and DIALOG_SYMBOL_PROPERTIES::TransferDataFromWindow().

◆ GetFocusPosition()

virtual const VECTOR2I EDA_ITEM::GetFocusPosition ( ) const

inlinevirtualinherited

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

Reimplemented in BOARD, PCB_SHAPE, and PCB_TRACK.

Definition at line 256 of file eda_item.h.

256{ return GetPosition(); }

EDA_ITEM::GetPosition

virtual VECTOR2I GetPosition() const

Definition: eda_item.h:249

References EDA_ITEM::GetPosition().

Referenced by SCH_EDIT_FRAME::FocusOnItem().

◆ GetInstances()

const std::vector< SCH_SHEET_INSTANCE > & SCH_SHEET::GetInstances ( ) const

inline

Returns: the list of SCH_SHEET_INSTANCE objects for this sheet.

Definition at line 378 of file sch_sheet.h.

378{ return m_instances; }

References m_instances.

◆ GetLayer()

SCH_LAYER_ID SCH_ITEM::GetLayer ( ) const

inlineinherited

Return the layer this item is on.

Definition at line 246 of file sch_item.h.

246{ return m_layer; }

References SCH_ITEM::m_layer.

Referenced by SCH_ITEM::CanConnect(), SCH_BUS_WIRE_ENTRY::CanConnect(), SCH_BUS_BUS_ENTRY::CanConnect(), SCH_LABEL_BASE::CanConnect(), SCH_LINE::CanConnect(), SCH_NO_CONNECT::CanConnect(), CanConnect(), SCH_SYMBOL::CanConnect(), SCH_BUS_WIRE_ENTRY::ConnectionPropagatesTo(), DIALOG_IMAGE_PROPERTIES::DIALOG_IMAGE_PROPERTIES(), SCH_LINE_WIRE_BUS_TOOL::doDrawSegments(), SCH_SCREEN::doIsJunction(), KIGFX::SCH_PAINTER::draw(), CONNECTION_GRAPH::ercCheckBusToNetConflicts(), CONNECTION_GRAPH::ercCheckFloatingWires(), SCH_MOVE_TOOL::getConnectedDragItems(), SCH_BUS_ENTRY_BASE::GetMsgPanelInfo(), SCH_LINE::GetMsgPanelInfo(), SCH_EDIT_TOOL::Init(), SCH_LINE::IsBus(), SCH_LINE::IsGraphicLine(), SCH_LINE::IsWire(), SCH_SCREEN::MarkConnections(), SCH_LINE::MergeOverlap(), SCH_BUS_ENTRY_BASE::operator<(), SCH_JUNCTION::operator<(), SCH_LINE::operator<(), SCH_TEXT::operator<(), SCH_TEXTBOX::operator<(), SCH_BITMAP::Plot(), SCH_FIELD::Plot(), SCH_JUNCTION::Plot(), SCH_LINE::Plot(), SCH_JUNCTION::Print(), SCH_LINE::Print(), SCH_LEGACY_PLUGIN::saveBusEntry(), SCH_LEGACY_PLUGIN::saveLine(), SCH_SEXPR_PLUGIN::saveLine(), SCH_LEGACY_PLUGIN::saveText(), SCH_EDIT_FRAME::TrimWire(), and CONNECTION_GRAPH::updateItemConnectivity().

◆ GetMenuImage()

BITMAPS SCH_SHEET::GetMenuImage ( ) const

overridevirtual

Return a pointer to an image to be used in menus.

The default version returns the right arrow image. Override this function to provide object specific menu images.

Returns: The menu image associated with the item.

Reimplemented from EDA_ITEM.

Definition at line 1044 of file sch_sheet.cpp.

{
 return BITMAPS::add_hierarchical_subsheet;
}

References add_hierarchical_subsheet.

◆ GetMinHeight()

int SCH_SHEET::GetMinHeight ( bool aFromTop ) const

Return the minimum height that the sheet can be resized based on the sheet pin positions.

The minimum width of a sheet is determined by the Y axis location of the bottom most sheet pin. If at some point in the future sheet objects can be rotated or pins can be placed in the vertical orientation, this function will need to be changed.

Returns: The minimum height the sheet can be resized.

Definition at line 506 of file sch_sheet.cpp.

{
 int pinsTop = m_pos.y + m_size.y;
 int pinsBottom = m_pos.y;
 
 for( size_t i = 0; i < m_pins.size(); i++ )
 {
 SHEET_SIDE edge = m_pins[i]->GetSide();
 
 if( edge == SHEET_SIDE::RIGHT || edge == SHEET_SIDE::LEFT )
 {
 BOX2I pinRect = m_pins[i]->GetBoundingBox();
 
 pinsTop = std::min( pinsTop, pinRect.GetTop() );
 pinsBottom = std::max( pinsBottom, pinRect.GetBottom() );
 }
 }
 
 pinsTop = bumpToNextGrid( pinsTop, -1 );
 pinsBottom = bumpToNextGrid( pinsBottom, 1 );
 
 int pinMinHeight;
 
 if( pinsTop >= pinsBottom )
 pinMinHeight = 0;
 else if( aFromTop )
 pinMinHeight = pinsBottom - m_pos.y;
 else
 pinMinHeight = m_pos.y + m_size.y - pinsTop;
 
 return std::max( pinMinHeight, schIUScale.MilsToIU( MIN_SHEET_HEIGHT ) );
}

References bumpToNextGrid(), BOX2< Vec >::GetBottom(), BOX2< Vec >::GetTop(), LEFT, m_pins, m_pos, m_size, EDA_IU_SCALE::MilsToIU(), MIN_SHEET_HEIGHT, RIGHT, schIUScale, and VECTOR2< T >::y.

Referenced by EE_POINT_EDITOR::updateParentItem().

◆ GetMinWidth()

int SCH_SHEET::GetMinWidth ( bool aFromLeft ) const

Return the minimum width of the sheet based on the widths of the sheet pin text.

The minimum sheet width is determined by the width of the bounding box of each hierarchical sheet pin. If two pins are horizontally adjacent ( same Y position ) to each other, the sum of the bounding box widths is used. If at some point in the future sheet objects can be rotated or pins can be placed in the vertical orientation, this function will need to be changed.

Returns: The minimum width the sheet can be resized.

Definition at line 472 of file sch_sheet.cpp.

{
 int pinsLeft = m_pos.x + m_size.x;
 int pinsRight = m_pos.x;
 
 for( size_t i = 0; i < m_pins.size(); i++ )
 {
 SHEET_SIDE edge = m_pins[i]->GetSide();
 
 if( edge == SHEET_SIDE::TOP || edge == SHEET_SIDE::BOTTOM )
 {
 BOX2I pinRect = m_pins[i]->GetBoundingBox();
 
 pinsLeft = std::min( pinsLeft, pinRect.GetLeft() );
 pinsRight = std::max( pinsRight, pinRect.GetRight() );
 }
 }
 
 pinsLeft = bumpToNextGrid( pinsLeft, -1 );
 pinsRight = bumpToNextGrid( pinsRight, 1 );
 
 int pinMinWidth;
 
 if( pinsLeft >= pinsRight )
 pinMinWidth = 0;
 else if( aFromLeft )
 pinMinWidth = pinsRight - m_pos.x;
 else
 pinMinWidth = m_pos.x + m_size.x - pinsLeft;
 
 return std::max( pinMinWidth, schIUScale.MilsToIU( MIN_SHEET_WIDTH ) );
}

References BOTTOM, bumpToNextGrid(), BOX2< Vec >::GetLeft(), BOX2< Vec >::GetRight(), m_pins, m_pos, m_size, EDA_IU_SCALE::MilsToIU(), MIN_SHEET_WIDTH, schIUScale, TOP, and VECTOR2< T >::x.

Referenced by EE_POINT_EDITOR::updateParentItem().

◆ GetMsgPanelInfo()

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

overridevirtual

Populate aList of MSG_PANEL_ITEM objects with it's internal state for display purposes.

Parameters

aList is the list to populate.

Reimplemented from EDA_ITEM.

Definition at line 781 of file sch_sheet.cpp.

{
 aList.emplace_back( _( "Sheet Name" ), m_fields[ SHEETNAME ].GetText() );
 
 if( SCH_EDIT_FRAME* schframe = dynamic_cast<SCH_EDIT_FRAME*>( aFrame ) )
 {
 SCH_SHEET_PATH path = schframe->GetCurrentSheet();
 path.push_back( this );
 
 aList.emplace_back( _( "Hierarchical Path" ), path.PathHumanReadable( false ) );
 }
 
 aList.emplace_back( _( "File Name" ), m_fields[ SHEETFILENAME ].GetText() );
}

References _, EDA_UNIT_UTILS::GetText(), m_fields, path, SHEETFILENAME, and SHEETNAME.

◆ GetName()

wxString SCH_SHEET::GetName ( void ) const

inline

◆ GetOrInitConnection()

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

inherited

Definition at line 228 of file sch_item.cpp.

{
 if( !IsConnectable() )
 return nullptr;
 
 SetConnectivityDirty( false );
 
 SCH_CONNECTION* connection = Connection( &aSheet );
 
 if( connection )
 return connection;
 else
 return InitializeConnection( aSheet, aGraph );
}

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

◆ GetPageNumber()

wxString SCH_SHEET::GetPageNumber ( const SCH_SHEET_PATH & aInstance ) const

Return the sheet page number for aInstance.

Warning: The SCH_SHEET_PATH object must be a full hierarchical path which means the SCH_SHEET object at index 0 must be the root sheet. A partial sheet path will raise an assertion on debug builds and silently fail and return an empty page number on release builds.

Returns: the page number for the requested sheet instance.

Definition at line 1230 of file sch_sheet.cpp.

{
 wxCHECK( aSheetPath.IsFullPath(), wxEmptyString );
 
 wxString pageNumber;
 KIID_PATH path = aSheetPath.Path();
 
 for( const SCH_SHEET_INSTANCE& instance : m_instances )
 {
 if( instance.m_Path == path )
 {
 pageNumber = instance.m_PageNumber;
 break;
 }
 }
 
 return pageNumber;
}

References SCH_SHEET_PATH::IsFullPath(), m_instances, SCH_SHEET_PATH::Path(), and path.

Referenced by SCH_SHEET_LIST::AllSheetPageNumbersEmpty(), HIERARCHY_NAVIG_PANEL::buildHierarchyTree(), SCH_EDITOR_CONTROL::FindNext(), SCH_SHEET_PATH::GetPageNumber(), HIERARCHY_NAVIG_PANEL::getRootString(), SCH_SHEET_LIST::GetSheetInstances(), Plot(), ResolveTextVar(), and DIALOG_SHEET_PROPERTIES::TransferDataToWindow().

◆ GetParent()

EDA_ITEM * EDA_ITEM::GetParent ( void ) const

inlineinherited

Definition at line 99 of file eda_item.h.

99{ return m_parent; }

EDA_ITEM::m_parent

EDA_ITEM * m_parent

Linked list: Link (parent struct)

Definition: eda_item.h:496

References EDA_ITEM::m_parent.

Referenced by SCH_EDIT_FRAME::AddItemToScreenAndUndoList(), SCH_EDIT_TOOL::AutoplaceFields(), DIALOG_SCH_FIELD_PROPERTIES::DIALOG_SCH_FIELD_PROPERTIES(), KIGFX::SCH_PAINTER::draw(), SCH_EDIT_TOOL::editFieldText(), SCH_FIELD::GetFieldColor(), getInferredSymbols(), SCH_PIN::GetParentSymbol(), EE_SELECTION_TOOL::highlight(), highlightNet(), SCH_FIELD::HitTest(), SCH_PIN::IsStacked(), CADSTAR_SCH_ARCHIVE_LOADER::loadNets(), SCH_EDIT_TOOL::Mirror(), SCH_MOVE_TOOL::moveItem(), SCH_EDITOR_CONTROL::nextMatch(), DIALOG_SCH_FIELD_PROPERTIES::onScintillaCharAdded(), BOARD_COMMIT::parentObject(), DIALOG_GLOBAL_EDIT_TEXT_AND_GRAPHICS::processItem(), PCB_SELECTION_TOOL::RebuildSelection(), SCH_BASE_FRAME::RefreshZoomDependentItems(), SCH_EDITOR_CONTROL::ReplaceAll(), SCH_EDIT_TOOL::Rotate(), EE_TOOL_BASE< T >::saveCopyInUndoList(), SCH_ITEM::Schematic(), SCH_SCREEN::Schematic(), SearchHierarchy(), PCB_SELECTION_TOOL::select(), BOARD_COMMIT::Stage(), DIALOG_SYMBOL_FIELDS_TABLE::TransferDataToWindow(), EE_SELECTION_TOOL::unhighlight(), DIALOG_SCH_FIELD_PROPERTIES::UpdateField(), EE_TOOL_BASE< T >::updateItem(), and SCH_BASE_FRAME::UpdateItem().

◆ GetPenWidth()

int SCH_SHEET::GetPenWidth ( ) const

overridevirtual

Returns: the size of the "pen" that be used to draw or plot this item

Reimplemented from SCH_ITEM.

Definition at line 578 of file sch_sheet.cpp.

{
 if( GetBorderWidth() > 0 )
 return GetBorderWidth();
 
 if( Schematic() )
 return Schematic()->Settings().m_DefaultLineWidth;
 
 return schIUScale.MilsToIU( DEFAULT_LINE_WIDTH_MILS );
}

References DEFAULT_LINE_WIDTH_MILS, GetBorderWidth(), SCHEMATIC_SETTINGS::m_DefaultLineWidth, EDA_IU_SCALE::MilsToIU(), SCH_ITEM::Schematic(), schIUScale, and SCHEMATIC::Settings().

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

◆ GetPin()

SCH_SHEET_PIN * SCH_SHEET::GetPin ( const VECTOR2I & aPosition )

Return the sheet pin item found at aPosition in the sheet.

Parameters

aPosition The position to check for a sheet pin.

Returns: The sheet pin found at aPosition or NULL if no sheet pin is found.

Definition at line 566 of file sch_sheet.cpp.

{
 for( SCH_SHEET_PIN* pin : m_pins )
 {
 if( pin->HitTest( aPosition ) )
 return pin;
 }
 
 return nullptr;
}

References m_pins, and pin.

Referenced by SCH_SCREEN::GetSheetPin().

◆ GetPins() [1/2]

std::vector< SCH_SHEET_PIN * > & SCH_SHEET::GetPins ( )

inline

Definition at line 172 of file sch_sheet.h.

172{ return m_pins; }

References m_pins.

Referenced by SCH_MOVE_TOOL::AlignElements(), KIGFX::SCH_PAINTER::draw(), CONNECTION_GRAPH::ercCheckHierSheets(), SCH_LINE_WIRE_BUS_TOOL::getSheetPin(), SCH_EDITOR_CONTROL::Paste(), SCH_LEGACY_PLUGIN::saveSheet(), SCH_SEXPR_PLUGIN::saveSheet(), EE_SELECTION_TOOL::SelectAll(), SCH_EDITOR_CONTROL::UpdateNetHighlighting(), EE_POINT_EDITOR::updateParentItem(), and DIALOG_GLOBAL_EDIT_TEXT_AND_GRAPHICS::visitItem().

◆ GetPins() [2/2]

const std::vector< SCH_SHEET_PIN * > & SCH_SHEET::GetPins ( ) const

inline

Definition at line 173 of file sch_sheet.h.

173{ return m_pins; }

References m_pins.

◆ GetPosition()

VECTOR2I SCH_SHEET::GetPosition ( ) const

inlineoverridevirtual

Reimplemented from EDA_ITEM.

Definition at line 365 of file sch_sheet.h.

365{ return m_pos; }

References m_pos.

Referenced by SCH_MOVE_TOOL::AlignElements(), KIGFX::SCH_PAINTER::draw(), TEST_EE_ITEM_FIXTURE::Instantiate(), CADSTAR_SCH_ARCHIVE_LOADER::loadNets(), EDIT_POINTS_FACTORY::Make(), SCH_LEGACY_PLUGIN::saveSheet(), SCH_SEXPR_PLUGIN::saveSheet(), SCH_DRAWING_TOOLS::sizeSheet(), ERC_TESTER::TestDuplicateSheetNames(), DIALOG_SHEET_PROPERTIES::TransferDataFromWindow(), DIALOG_SHEET_PROPERTIES::TransferDataToWindow(), EE_POINT_EDITOR::updateParentItem(), and EE_POINT_EDITOR::updatePoints().

◆ GetRotationCenter()

VECTOR2I SCH_SHEET::GetRotationCenter ( ) const

Rotating around the boundingBox's center can cause walking when the sheetname or filename is longer than the edge it's on.

Use this instead, which always returns the center of the sheet itself.

Definition at line 678 of file sch_sheet.cpp.

{
 BOX2I box( m_pos, m_size );
 return box.GetCenter();
}

References BOX2< Vec >::GetCenter(), m_pos, and m_size.

Referenced by SCH_EDIT_TOOL::Rotate().

◆ GetScreen()

SCH_SCREEN * SCH_SHEET::GetScreen ( ) const

inline

Definition at line 103 of file sch_sheet.h.

103{ return m_screen; }

References m_screen.

◆ GetScreenCount()

int SCH_SHEET::GetScreenCount ( ) const

Return the number of times the associated screen for the sheet is being used.

If no screen is associated with the sheet, then zero is returned.

Definition at line 185 of file sch_sheet.cpp.

{
 if( m_screen == nullptr )
 return 0;
 
 return m_screen->GetRefCount();
}

References SCH_SCREEN::GetRefCount(), and m_screen.

Referenced by DIALOG_SHEET_PROPERTIES::onSheetFilenameChanged().

◆ GetSelectMenuText()

wxString SCH_SHEET::GetSelectMenuText ( UNITS_PROVIDER * aUnitsProvider ) const

overridevirtual

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

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

Returns: The menu text string.

Reimplemented from EDA_ITEM.

Definition at line 1037 of file sch_sheet.cpp.

{
 return wxString::Format( _( "Hierarchical Sheet %s" ),
 m_fields[ SHEETNAME ].GetText() );
}

References _, Format(), EDA_UNIT_UTILS::GetText(), m_fields, and SHEETNAME.

◆ GetSize()

wxSize SCH_SHEET::GetSize ( ) const

inline

Definition at line 105 of file sch_sheet.h.

105{ return m_size; }

References m_size.

Referenced by SCH_MOVE_TOOL::AlignElements(), KIGFX::SCH_PAINTER::draw(), CADSTAR_SCH_ARCHIVE_LOADER::loadNets(), EDIT_POINTS_FACTORY::Make(), SCH_LEGACY_PLUGIN::saveSheet(), SCH_SEXPR_PLUGIN::saveSheet(), EE_POINT_EDITOR::updateParentItem(), and EE_POINT_EDITOR::updatePoints().

◆ GetSortPosition()

virtual VECTOR2I EDA_ITEM::GetSortPosition ( ) const

inlinevirtualinherited

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

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

Returns: X,Y coordinate of the sort point

Reimplemented in SCH_LINE.

Definition at line 265 of file eda_item.h.

265{ return GetPosition(); }

References EDA_ITEM::GetPosition().

◆ GetState()

int EDA_ITEM::GetState ( EDA_ITEM_FLAGS type ) const

inlineinherited

Definition at line 126 of file eda_item.h.

 {
 return m_status & type;
 }

References EDA_ITEM::m_status.

◆ GetStatus()

EDA_ITEM_FLAGS EDA_ITEM::GetStatus ( ) const

inlineinherited

Definition at line 139 of file eda_item.h.

139{ return m_status; }

References EDA_ITEM::m_status.

◆ GetStoredPos()

VECTOR2I & SCH_ITEM::GetStoredPos ( )

inlineinherited

Definition at line 209 of file sch_item.h.

209{ return m_storedPos; }

SCH_ITEM::m_storedPos

VECTOR2I m_storedPos

Definition: sch_item.h:494

References SCH_ITEM::m_storedPos.

◆ GetStroke()

virtual STROKE_PARAMS SCH_ITEM::GetStroke ( ) const

inlinevirtualinherited

Reimplemented in SCH_BUS_ENTRY_BASE, SCH_LINE, and SCH_SHAPE.

Definition at line 457 of file sch_item.h.

457{ wxCHECK( false, STROKE_PARAMS() ); }

STROKE_PARAMS

Simple container to manage line stroke parameters.

Definition: stroke_params.h:88

Referenced by DIALOG_GLOBAL_EDIT_TEXT_AND_GRAPHICS::processItem().

◆ GetTypeDesc()

wxString EDA_ITEM::GetTypeDesc ( )

inherited

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

Definition at line 301 of file eda_item.cpp.

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

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

Referenced by PROPERTIES_PANEL::update().

◆ HasFlag()

bool EDA_ITEM::HasFlag ( EDA_ITEM_FLAGS aFlag ) const

inlineinherited

Definition at line 145 of file eda_item.h.

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

References EDA_ITEM::m_flags.

Referenced by GRAPHICS_CLEANER::cleanupShapes(), SCH_EDIT_TOOL::DoDelete(), EDIT_TOOL::doMoveSelection(), KIGFX::SCH_PAINTER::draw(), SCH_MOVE_TOOL::getConnectedDragItems(), SCH_MOVE_TOOL::getConnectedItems(), FOOTPRINT::IsConflicting(), SCH_MOVE_TOOL::Main(), SCH_SCREEN::MarkConnections(), SCH_MOVE_TOOL::moveItem(), SCH_MOVE_TOOL::orthoLineDrag(), SYMBOL_EDITOR_PIN_TOOL::PlacePin(), SCH_EDIT_TOOL::Rotate(), and EE_TOOL_BASE< T >::saveCopyInUndoList().

◆ HasLineStroke()

virtual bool SCH_ITEM::HasLineStroke ( ) const

inlinevirtualinherited

Check if this schematic item has line stoke properties.

See also: STROKE_PARAMS

Returns: true if this schematic item support line stroke properties. Otherwise, false.

Reimplemented in SCH_BUS_ENTRY_BASE, SCH_LINE, and SCH_SHAPE.

Definition at line 455 of file sch_item.h.

455{ return false; }

Referenced by SCH_EDIT_TOOL::Init(), and DIALOG_GLOBAL_EDIT_TEXT_AND_GRAPHICS::processItem().

◆ HasPin()

bool SCH_SHEET::HasPin ( const wxString & aName ) const

Checks if the sheet already has a sheet pin named aName.

Parameters

aName Name of the sheet pin to search for.

Returns: True if sheet pin with aName is found, otherwise false.

Definition at line 381 of file sch_sheet.cpp.

{
 for( SCH_SHEET_PIN* pin : m_pins )
 {
 if( pin->GetText().CmpNoCase( aName ) == 0 )
 return true;
 }
 
 return false;
}

References m_pins, and pin.

Referenced by SCH_DRAWING_TOOLS::importHierLabel().

◆ HasPins()

bool SCH_SHEET::HasPins ( ) const

inline

Definition at line 207 of file sch_sheet.h.

207{ return !m_pins.empty(); }

References m_pins.

◆ HasUndefinedPins()

bool SCH_SHEET::HasUndefinedPins ( ) const

Check all sheet labels against schematic for undefined hierarchical labels.

Returns: True if there are any undefined labels.

Definition at line 426 of file sch_sheet.cpp.

{
 for( SCH_SHEET_PIN* pin : m_pins )
 {
 /* Search the schematic for a hierarchical label corresponding to this sheet label. */
 const SCH_HIERLABEL* HLabel = nullptr;
 
 for( SCH_ITEM* aItem : m_screen->Items().OfType( SCH_HIER_LABEL_T ) )
 {
 if( !pin->GetText().CmpNoCase( static_cast<SCH_HIERLABEL*>( aItem )->GetText() ) )
 {
 HLabel = static_cast<SCH_HIERLABEL*>( aItem );
 break;
 }
 }
 
 if( HLabel == nullptr ) // Corresponding hierarchical label not found.
 return true;
 }
 
 return false;
}

References EDA_TEXT::GetText(), SCH_SCREEN::Items(), m_pins, m_screen, EE_RTREE::OfType(), pin, and SCH_HIER_LABEL_T.

Referenced by SCH_EDIT_TOOL::CleanupSheetPins().

◆ HitTest() [1/2]

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

overridevirtual

Test if aRect intersects this item.

Parameters

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

Returns: True if aRect contains or intersects the item bounding box.

Reimplemented from EDA_ITEM.

Definition at line 1060 of file sch_sheet.cpp.

{
 BOX2I rect = aRect;
 
 rect.Inflate( aAccuracy );
 
 if( aContained )
 return rect.Contains( GetBodyBoundingBox() );
 
 return rect.Intersects( GetBodyBoundingBox() );
}

References BOX2< Vec >::Contains(), GetBodyBoundingBox(), BOX2< Vec >::Inflate(), and BOX2< Vec >::Intersects().

◆ HitTest() [2/2]

bool SCH_SHEET::HitTest	(	const VECTOR2I &	aPosition,
		int	aAccuracy
	)		const

overridevirtual

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

Parameters

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

Returns: True if aPosition is within the item bounding box.

Reimplemented from EDA_ITEM.

Definition at line 1050 of file sch_sheet.cpp.

{
 BOX2I rect = GetBodyBoundingBox();
 
 rect.Inflate( aAccuracy );
 
 return rect.Contains( aPosition );
}

References BOX2< Vec >::Contains(), GetBodyBoundingBox(), and BOX2< Vec >::Inflate().

◆ InitializeConnection()

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

inherited

Create a new connection object associated with this object.

Parameters

aPath is the sheet path to initialize.

Definition at line 205 of file sch_item.cpp.

{
 SetConnectivityDirty( false );
 
 SCH_CONNECTION* connection = Connection( &aSheet );
 
 if( connection )
 {
 connection->Reset();
 }
 else
 {
 connection = new SCH_CONNECTION( this );
 m_connection_map.insert( std::make_pair( aSheet, connection ) );
 }
 
 connection->SetGraph( aGraph );
 connection->SetSheet( aSheet );
 return connection;
}

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

Referenced by SCH_ITEM::GetOrInitConnection().

◆ IsBrightened()

bool EDA_ITEM::IsBrightened ( ) const

inlineinherited

Definition at line 110 of file eda_item.h.

110{ return m_flags & BRIGHTENED; }

References BRIGHTENED, and EDA_ITEM::m_flags.

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

◆ IsConnectable()

bool SCH_SHEET::IsConnectable ( ) const

inlineoverridevirtual

Returns: true if the schematic item can connect to another schematic item.

Reimplemented from SCH_ITEM.

Definition at line 338 of file sch_sheet.h.

338{ return true; }

◆ IsConnected()

bool SCH_ITEM::IsConnected ( const VECTOR2I & aPoint ) const

inherited

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

Parameters

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

Returns: True if connection to aPoint exists.

Definition at line 137 of file sch_item.cpp.

{
 if(( m_flags & STRUCT_DELETED ) || ( m_flags & SKIP_STRUCT ) )
 return false;
 
 return doIsConnected( aPosition );
}

References SCH_ITEM::doIsConnected(), EDA_ITEM::m_flags, SKIP_STRUCT, and STRUCT_DELETED.

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

◆ IsConnectivityDirty()

bool SCH_ITEM::IsConnectivityDirty ( ) const

inlineinherited

Definition at line 413 of file sch_item.h.

413{ return m_connectivity_dirty; }

SCH_ITEM::m_connectivity_dirty

bool m_connectivity_dirty

Definition: sch_item.h:503

References SCH_ITEM::m_connectivity_dirty.

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

◆ IsDangling()

virtual bool SCH_ITEM::IsDangling ( ) const

inlinevirtualinherited

Reimplemented in SCH_BUS_ENTRY_BASE, SCH_LABEL_BASE, SCH_LINE, and SCH_PIN.

Definition at line 342 of file sch_item.h.

342{ return false; }

Referenced by SCH_EDIT_TOOL::ChangeTextType(), and KIGFX::SCH_PAINTER::draw().

◆ IsDragging()

bool EDA_ITEM::IsDragging ( ) const

inlineinherited

Definition at line 105 of file eda_item.h.

105{ return m_flags & IS_DRAGGING; }

References IS_DRAGGING, and EDA_ITEM::m_flags.

Referenced by DIALOG_SYMBOL_PROPERTIES::DIALOG_SYMBOL_PROPERTIES().

◆ IsEntered()

bool EDA_ITEM::IsEntered ( ) const

inlineinherited

Definition at line 108 of file eda_item.h.

108{ return m_flags & ENTERED; }

ENTERED

#define ENTERED

indicates a group has been entered

Definition: eda_item_flags.h:73

References ENTERED, and EDA_ITEM::m_flags.

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

◆ IsForceVisible()

bool EDA_ITEM::IsForceVisible ( ) const

inlineinherited

Definition at line 203 of file eda_item.h.

203{ return m_forceVisible; }

EDA_ITEM::m_forceVisible

bool m_forceVisible

Definition: eda_item.h:497

References EDA_ITEM::m_forceVisible.

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

◆ IsHypertext()

virtual bool SCH_ITEM::IsHypertext ( ) const

inlinevirtualinherited

Allow items to support hypertext actions when hovered/clicked.

Reimplemented in SCH_FIELD, SCH_TEXT, and SCH_TEXTBOX.

Definition at line 239 of file sch_item.h.

239{ return false; }

Referenced by SCH_ITEM::RenderAsBitmap().

◆ IsLocked()

virtual bool SCH_ITEM::IsLocked ( ) const

inlinevirtualinherited

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

Definition at line 229 of file sch_item.h.

229{ return false; }

◆ IsModified()

bool EDA_ITEM::IsModified ( ) const

inlineinherited

Definition at line 102 of file eda_item.h.

102{ return m_flags & IS_CHANGED; }

References IS_CHANGED, and EDA_ITEM::m_flags.

Referenced by PCB_EDIT_FRAME::OpenProjectFiles().

◆ IsMovableFromAnchorPoint()

bool SCH_SHEET::IsMovableFromAnchorPoint ( ) const

inlineoverridevirtual

Return true for items which are moved with the anchor point at mouse cursor and false for items moved with no reference to anchor.

Usually return true for small items (labels, junctions) and false for items which can be large (hierarchical sheets, symbols).

Returns: false for a hierarchical sheet.

Reimplemented from SCH_ITEM.

Definition at line 89 of file sch_sheet.h.

89{ return false; }

◆ IsMoving()

bool EDA_ITEM::IsMoving ( ) const

inlineinherited

Definition at line 104 of file eda_item.h.

104{ return m_flags & IS_MOVING; }

References IS_MOVING, and EDA_ITEM::m_flags.

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

◆ IsNew()

bool EDA_ITEM::IsNew ( ) const

inlineinherited

Definition at line 103 of file eda_item.h.

103{ return m_flags & IS_NEW; }

References IS_NEW, and EDA_ITEM::m_flags.

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

◆ IsPointClickableAnchor()

virtual bool SCH_ITEM::IsPointClickableAnchor ( const VECTOR2I & aPos ) const

inlinevirtualinherited

Returns: true if the given point can start drawing (usually means the anchor is unused/free/dangling).

Reimplemented in SCH_BUS_ENTRY_BASE, SCH_JUNCTION, SCH_LABEL, SCH_GLOBALLABEL, SCH_HIERLABEL, SCH_LINE, SCH_PIN, SCH_SHEET_PIN, and SCH_SYMBOL.

Definition at line 355 of file sch_item.h.

355{ return false; }

Referenced by EE_SELECTION_TOOL::autostartEvent().

◆ IsReplaceable()

bool SCH_SHEET::IsReplaceable ( ) const

inlineoverridevirtual

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

Definition at line 322 of file sch_sheet.h.

322{ return true; }

◆ IsResized()

bool EDA_ITEM::IsResized ( ) const

inlineinherited

Definition at line 109 of file eda_item.h.

109{ return m_flags & IS_RESIZING; }

References IS_RESIZING, and EDA_ITEM::m_flags.

◆ IsRollover()

bool EDA_ITEM::IsRollover ( ) const

inlineinherited

Definition at line 112 of file eda_item.h.

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

References IS_MOVING, IS_ROLLOVER, and EDA_ITEM::m_flags.

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

◆ IsRootSheet()

bool SCH_SHEET::IsRootSheet ( ) const

Returns: true if this sheet is the root sheet.

Definition at line 194 of file sch_sheet.cpp.

{
 wxCHECK_MSG( Schematic(), false, "Can't call IsRootSheet without setting a schematic" );
 
 return &Schematic()->Root() == this;
}

References SCHEMATIC::Root(), and SCH_ITEM::Schematic().

Referenced by SCH_SEXPR_PLUGIN::Format(), SCH_SHEET_PATH::IsFullPath(), SCH_EDIT_FRAME::SaveProject(), and SCH_SHEET_LIST::SCH_SHEET_LIST().

◆ IsSelected()

bool EDA_ITEM::IsSelected ( ) const

inlineinherited

Definition at line 107 of file eda_item.h.

107{ return m_flags & SELECTED; }

References EDA_ITEM::m_flags, and SELECTED.

◆ IsShownAsBitmap()

bool EDA_ITEM::IsShownAsBitmap ( ) const

inlineinherited

Definition at line 175 of file eda_item.h.

175{ return m_flags & IS_SHOWN_AS_BITMAP; }

IS_SHOWN_AS_BITMAP

#define IS_SHOWN_AS_BITMAP

Definition: eda_item_flags.h:55

References IS_SHOWN_AS_BITMAP, and EDA_ITEM::m_flags.

◆ IsType()

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

inlineoverridevirtualinherited

Check whether the item is one of the listed types.

Parameters

aScanTypes List of item types

Returns: true if the item type is contained in the list aScanTypes

Reimplemented from EDA_ITEM.

Reimplemented in SCH_LABEL_BASE, and SCH_LINE.

Definition at line 162 of file sch_item.h.

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

References EDA_ITEM::IsType(), LAYER_BUS, LAYER_NOTES, LAYER_WIRE, SCH_ITEM::m_layer, SCH_ITEM_LOCATE_BUS_T, SCH_ITEM_LOCATE_GRAPHIC_LINE_T, SCH_ITEM_LOCATE_WIRE_T, SCH_LINE_T, and EDA_ITEM::Type().

Referenced by SCH_EDIT_TOOL::AutoplaceFields(), SCH_EDIT_FRAME::AutoRotateItem(), SCH_FIELD::IsType(), SCH_LABEL_BASE::IsType(), SCH_LINE::IsType(), and DIALOG_GLOBAL_EDIT_TEXT_AND_GRAPHICS::visitItem().

◆ IsVerticalOrientation()

bool SCH_SHEET::IsVerticalOrientation ( ) const

Definition at line 405 of file sch_sheet.cpp.

{
 int leftRight = 0;
 int topBottom = 0;
 
 for( SCH_SHEET_PIN* pin : m_pins )
 {
 switch( pin->GetSide() )
 {
 case SHEET_SIDE::LEFT: leftRight++; break;
 case SHEET_SIDE::RIGHT: leftRight++; break;
 case SHEET_SIDE::TOP: topBottom++; break;
 case SHEET_SIDE::BOTTOM: topBottom++; break;
 default: break;
 }
 }
 
 return topBottom > 0 && leftRight == 0;
}

References BOTTOM, LEFT, m_pins, pin, RIGHT, and TOP.

Referenced by AutoplaceFields(), and SCH_SHEET_PIN::SCH_SHEET_PIN().

◆ IsWireImage()

bool EDA_ITEM::IsWireImage ( ) const

inlineinherited

Definition at line 106 of file eda_item.h.

106{ return m_flags & IS_WIRE_IMAGE; }

References IS_WIRE_IMAGE, and EDA_ITEM::m_flags.

◆ IterateForward() [1/2]

template<class T >

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

inlinestaticinherited

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

Definition at line 302 of file eda_item.h.

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

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

Referenced by GERBER_FILE_IMAGE::Visit().

◆ IterateForward() [2/2]

template<class T >

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

inlinestaticinherited

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

Definition at line 322 of file eda_item.h.

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

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

◆ LocatePathOfScreen()

bool SCH_SHEET::LocatePathOfScreen	(	SCH_SCREEN *	aScreen,
		SCH_SHEET_PATH *	aList
	)

Search the existing hierarchy for an instance of screen loaded from aFileName.

Don't bother looking at the root sheet, it must be unique. No other references to its m_screen otherwise there would be loops in the hierarchy.

Parameters

[in]	aScreen	The SCH_SCREEN* screen that we search for.
[in]	aList	The SCH_SHEET_PATH* that must be used.

Returns: true if found.

Definition at line 743 of file sch_sheet.cpp.

{
 if( m_screen )
 {
 aList->push_back( this );
 
 if( m_screen == aScreen )
 return true;
 
 for( EDA_ITEM* item : m_screen->Items().OfType( SCH_SHEET_T ) )
 {
 SCH_SHEET* sheet = static_cast<SCH_SHEET*>( item );
 
 if( sheet->LocatePathOfScreen( aScreen, aList ) )
 return true;
 }
 
 aList->pop_back();
 }
 
 return false;
}

References SCH_SCREEN::Items(), LocatePathOfScreen(), m_screen, EE_RTREE::OfType(), SCH_SHEET_PATH::pop_back(), SCH_SHEET_PATH::push_back(), and SCH_SHEET_T.

Referenced by SCH_EAGLE_PLUGIN::loadInstance(), SCH_EAGLE_PLUGIN::loadSchematic(), CADSTAR_SCH_ARCHIVE_LOADER::loadSchematicSymbol(), LocatePathOfScreen(), SCH_ALTIUM_PLUGIN::ParseDesignator(), SCH_ALTIUM_PLUGIN::ParseHarnessConnector(), SCH_ALTIUM_PLUGIN::ParseParameter(), SCH_ALTIUM_PLUGIN::ParsePowerPort(), and SCH_ALTIUM_PLUGIN::ParseSheetSymbol().

◆ Matches() [1/2]

bool SCH_SHEET::Matches	(	const EDA_SEARCH_DATA &	aSearchData,
		void *	aAuxData
	)		const

overridevirtual

Compare the item against the search criteria in aSearchData.

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

Parameters

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

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

Reimplemented from EDA_ITEM.

Definition at line 916 of file sch_sheet.cpp.

{
 // Sheets are searchable via the child field and pin item text.
 return false;
}

Referenced by SCH_DRAWING_TOOLS::DrawSheet().

◆ Matches() [2/2]

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

protectedinherited

Compare aText against search criteria in aSearchData.

This is a helper function for simplify derived class logic.

Parameters

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

Returns: True if aText matches the search criteria in aSearchData.

Definition at line 117 of file eda_item.cpp.

{
 wxString text = aText;
 wxString searchText = aSearchData.findString;
 
 // Don't match if searching for replaceable item and the item doesn't support text replace.
 if( aSearchData.searchAndReplace && !IsReplaceable() )
 return false;
 
 if( !aSearchData.matchCase )
 {
 text.MakeUpper();
 searchText.MakeUpper();
 }
 
 if( aSearchData.matchMode == EDA_SEARCH_MATCH_MODE::WHOLEWORD )
 {
 int ii = 0;
 
 while( ii < (int) text.length() )
 {
 int next = text.find( searchText, ii );
 
 if( next == wxNOT_FOUND )
 return false;
 
 ii = next;
 next += searchText.length();
 
 bool startOK = ( ii == 0 || !wxIsalnum( text.GetChar( ii - 1 ) ) );
 bool endOK = ( next == (int) text.length() || !wxIsalnum( text.GetChar( next ) ) );
 
 if( startOK && endOK )
 return true;
 else
 ii++;
 }
 
 return false;
 }
 else if( aSearchData.matchMode == EDA_SEARCH_MATCH_MODE::WILDCARD )
 {
 return text.Matches( searchText );
 }
 else
 {
 return text.Find( searchText ) != wxNOT_FOUND;
 }
}

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

◆ MirrorHorizontally()

void SCH_SHEET::MirrorHorizontally ( int aCenter )

overridevirtual

Mirror item horizontally about aCenter.

Implements SCH_ITEM.

Definition at line 871 of file sch_sheet.cpp.

{
 int dx = m_pos.x;
 
 MIRROR( m_pos.x, aCenter );
 m_pos.x -= m_size.x;
 dx -= m_pos.x; // dx,0 is the move vector for this transform
 
 for( SCH_SHEET_PIN* sheetPin : m_pins )
 sheetPin->MirrorHorizontally( aCenter );
 
 for( SCH_FIELD& field : m_fields )
 {
 VECTOR2I pos = field.GetTextPos();
 pos.x -= dx;
 field.SetTextPos( pos );
 }
}

References m_fields, m_pins, m_pos, m_size, MIRROR(), and VECTOR2< T >::x.

◆ MirrorVertically()

void SCH_SHEET::MirrorVertically ( int aCenter )

overridevirtual

Mirror item vertically about aCenter.

Implements SCH_ITEM.

Definition at line 851 of file sch_sheet.cpp.

{
 int dy = m_pos.y;
 
 MIRROR( m_pos.y, aCenter );
 m_pos.y -= m_size.y;
 dy -= m_pos.y; // 0,dy is the move vector for this transform
 
 for( SCH_SHEET_PIN* sheetPin : m_pins )
 sheetPin->MirrorVertically( aCenter );
 
 for( SCH_FIELD& field : m_fields )
 {
 VECTOR2I pos = field.GetTextPos();
 pos.y -= dy;
 field.SetTextPos( pos );
 }
}

References m_fields, m_pins, m_pos, m_size, MIRROR(), and VECTOR2< T >::y.

◆ Move()

void SCH_SHEET::Move ( const VECTOR2I & aMoveVector )

overridevirtual

Move the item by aMoveVector to a new position.

Implements SCH_ITEM.

Definition at line 797 of file sch_sheet.cpp.

{
 m_pos += aMoveVector;
 
 for( SCH_SHEET_PIN* pin : m_pins )
 pin->Move( aMoveVector );
 
 for( SCH_FIELD& field : m_fields )
 field.Move( aMoveVector );
}

References m_fields, m_pins, m_pos, and pin.

Referenced by SetPosition().

◆ operator<() [1/2]

bool EDA_ITEM::operator< ( const EDA_ITEM & aItem ) const

inherited

Test if another item is less than this object.

Parameters

aItem - Item to compare against.

Returns: - True if aItem is less than the item.

Definition at line 231 of file eda_item.cpp.

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

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

◆ operator<() [2/2]

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

overridevirtual

Reimplemented from SCH_ITEM.

Definition at line 1188 of file sch_sheet.cpp.

{
 if( Type() != aItem.Type() )
 return Type() < aItem.Type();
 
 auto sheet = static_cast<const SCH_SHEET*>( &aItem );
 
 if (m_fields[ SHEETNAME ].GetText() != sheet->m_fields[ SHEETNAME ].GetText() )
 return m_fields[ SHEETNAME ].GetText() < sheet->m_fields[ SHEETNAME ].GetText();
 
 if (m_fields[ SHEETFILENAME ].GetText() != sheet->m_fields[ SHEETFILENAME ].GetText() )
 return m_fields[ SHEETFILENAME ].GetText() < sheet->m_fields[ SHEETFILENAME ].GetText();
 
 return false;
}

References EDA_UNIT_UTILS::GetText(), m_fields, SHEETFILENAME, SHEETNAME, and EDA_ITEM::Type().

◆ operator=()

SCH_SHEET & SCH_SHEET::operator= ( const SCH_ITEM & aSheet )

Definition at line 1158 of file sch_sheet.cpp.

{
 wxCHECK_MSG( Type() == aItem.Type(), *this,
 wxT( "Cannot assign object type " ) + aItem.GetClass() + wxT( " to type " ) +
 GetClass() );
 
 if( &aItem != this )
 {
 SCH_ITEM::operator=( aItem );
 
 SCH_SHEET* sheet = (SCH_SHEET*) &aItem;
 
 m_pos = sheet->m_pos;
 m_size = sheet->m_size;
 m_fields = sheet->m_fields;
 
 for( SCH_SHEET_PIN* pin : sheet->m_pins )
 {
 m_pins.emplace_back( new SCH_SHEET_PIN( *pin ) );
 m_pins.back()->SetParent( this );
 }
 
 for( const SCH_SHEET_INSTANCE& instance : sheet->m_instances )
 m_instances.emplace_back( instance );
 }
 
 return *this;
}

References SCH_ITEM::GetClass(), GetClass(), m_fields, m_instances, m_pins, m_pos, m_size, SCH_ITEM::operator=(), pin, SCH_SHEET_PIN, and EDA_ITEM::Type().

◆ Plot()

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

overridevirtual

Plot the schematic item to aPlotter.

Parameters

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

Reimplemented from SCH_ITEM.

Definition at line 1073 of file sch_sheet.cpp.

{
 if( aBackground && !aPlotter->GetColorMode() )
 return;
 
 auto* settings = dynamic_cast<KIGFX::SCH_RENDER_SETTINGS*>( aPlotter->RenderSettings() );
 bool override = settings ? settings->m_OverrideItemColors : false;
 COLOR4D borderColor = GetBorderColor();
 COLOR4D backgroundColor = GetBackgroundColor();
 
 if( override || borderColor == COLOR4D::UNSPECIFIED )
 borderColor = aPlotter->RenderSettings()->GetLayerColor( LAYER_SHEET );
 
 if( override || backgroundColor == COLOR4D::UNSPECIFIED )
 backgroundColor = aPlotter->RenderSettings()->GetLayerColor( LAYER_SHEET_BACKGROUND );
 
 if( aBackground )
 {
 aPlotter->SetColor( backgroundColor );
 aPlotter->Rect( m_pos, m_pos + m_size, FILL_T::FILLED_SHAPE, 1 );
 }
 else
 {
 aPlotter->SetColor( borderColor );
 
 int penWidth = std::max( GetPenWidth(), aPlotter->RenderSettings()->GetMinPenWidth() );
 aPlotter->Rect( m_pos, m_pos + m_size, FILL_T::NO_FILL, penWidth );
 }
 
 // Make the sheet object a clickable hyperlink (e.g. for PDF plotter)
 std::vector<wxString> properties;
 
 properties.emplace_back( EDA_TEXT::GotoPageHref( GetPageNumber( findSelf() ) ) );
 
 for( const SCH_FIELD& field : GetFields() )
 {
 properties.emplace_back( wxString::Format( wxT( "!%s = %s" ),
 field.GetName(),
 field.GetShownText() ) );
 }
 
 aPlotter->HyperlinkMenu( GetBoundingBox(), properties );
 
 // Plot sheet pins
 for( SCH_SHEET_PIN* sheetPin : m_pins )
 sheetPin->Plot( aPlotter, aBackground );
 
 // Plot the fields
 for( const SCH_FIELD& field : m_fields )
 field.Plot( aPlotter, aBackground );
}

References FILLED_SHAPE, findSelf(), Format(), GetBackgroundColor(), GetBorderColor(), GetBoundingBox(), PLOTTER::GetColorMode(), GetFields(), KIGFX::RENDER_SETTINGS::GetLayerColor(), KIGFX::RENDER_SETTINGS::GetMinPenWidth(), GetPageNumber(), GetPenWidth(), EDA_TEXT::GotoPageHref(), PLOTTER::HyperlinkMenu(), LAYER_SHEET, LAYER_SHEET_BACKGROUND, m_fields, KIGFX::SCH_RENDER_SETTINGS::m_OverrideItemColors, m_pins, m_pos, m_size, NO_FILL, PLOTTER::Rect(), PLOTTER::RenderSettings(), and PLOTTER::SetColor().

◆ Print()

void SCH_SHEET::Print	(	const RENDER_SETTINGS *	aSettings,
		const VECTOR2I &	aOffset
	)

overridevirtual

Print a schematic item.

Each schematic item should have its own method

Parameters

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

Implements SCH_ITEM.

Definition at line 1126 of file sch_sheet.cpp.

{
 wxDC* DC = aSettings->GetPrintDC();
 VECTOR2I pos = m_pos + aOffset;
 int lineWidth = std::max( GetPenWidth(), aSettings->GetDefaultPenWidth() );
 const auto* settings = dynamic_cast<const KIGFX::SCH_RENDER_SETTINGS*>( aSettings );
 bool override = settings && settings->m_OverrideItemColors;
 COLOR4D border = GetBorderColor();
 COLOR4D background = GetBackgroundColor();
 
 if( override || border == COLOR4D::UNSPECIFIED )
 border = aSettings->GetLayerColor( LAYER_SHEET );
 
 if( override || background == COLOR4D::UNSPECIFIED )
 background = aSettings->GetLayerColor( LAYER_SHEET_BACKGROUND );
 
 if( GetGRForceBlackPenState() ) // printing in black & white
 background = COLOR4D::UNSPECIFIED;
 
 if( background != COLOR4D::UNSPECIFIED )
 GRFilledRect( DC, pos, pos + m_size, 0, background, background );
 
 GRRect( DC, pos, pos + m_size, lineWidth, border );
 
 for( SCH_FIELD& field : m_fields )
 field.Print( aSettings, aOffset );
 
 for( SCH_SHEET_PIN* sheetPin : m_pins )
 sheetPin->Print( aSettings, aOffset );
}

References GetBackgroundColor(), GetBorderColor(), KIGFX::RENDER_SETTINGS::GetDefaultPenWidth(), GetGRForceBlackPenState(), KIGFX::RENDER_SETTINGS::GetLayerColor(), GetPenWidth(), KIGFX::RENDER_SETTINGS::GetPrintDC(), GRFilledRect(), GRRect(), LAYER_SHEET, LAYER_SHEET_BACKGROUND, m_fields, KIGFX::SCH_RENDER_SETTINGS::m_OverrideItemColors, m_pins, m_pos, and m_size.

◆ PrintBackground()

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

inlinevirtualinherited

Print the (optional) backaground elements if they exist.

Parameters

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

Reimplemented in SCH_SHAPE, and SCH_SYMBOL.

Definition at line 286 of file sch_item.h.

286{};

◆ RemovePin()

void SCH_SHEET::RemovePin ( const SCH_SHEET_PIN * aSheetPin )

Remove aSheetPin from the sheet.

Parameters

aSheetPin The sheet pin item to remove from the sheet.

Definition at line 364 of file sch_sheet.cpp.

{
 wxASSERT( aSheetPin != nullptr );
 wxASSERT( aSheetPin->Type() == SCH_SHEET_PIN_T );
 
 for( auto i = m_pins.begin(); i < m_pins.end(); ++i )
 {
 if( *i == aSheetPin )
 {
 m_pins.erase( i );
 renumberPins();
 return;
 }
 }
}

References m_pins, renumberPins(), SCH_SHEET_PIN_T, and EDA_ITEM::Type().

Referenced by SCH_SCREEN::DeleteItem(), and SCH_EDIT_TOOL::DoDelete().

◆ RenderAsBitmap()

bool SCH_ITEM::RenderAsBitmap ( double aWorldScale ) const

overridevirtualinherited

Reimplemented from EDA_ITEM.

Definition at line 294 of file sch_item.cpp.

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

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

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

◆ renumberPins()

void SCH_SHEET::renumberPins ( )

protected

Renumber the sheet pins in the sheet.

This method is used internally by SCH_SHEET to update the pin numbering when the pin list changes. Make sure you call this method any time a sheet pin is added or removed.

Definition at line 923 of file sch_sheet.cpp.

{
 int id = 2;
 
 for( SCH_SHEET_PIN* pin : m_pins )
 {
 pin->SetNumber( id );
 id++;
 }
}

References m_pins, and pin.

Referenced by AddPin(), and RemovePin().

◆ Replace() [1/2]

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

inlinevirtualinherited

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

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

Parameters

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

Returns: True if the item text was modified, otherwise false.

Reimplemented in LIB_TEXTBOX, SCH_PIN, SCH_TEXT, SCH_TEXTBOX, SCH_FIELD, and SCH_SHEET_PIN.

Definition at line 409 of file eda_item.h.

 {
 return false;
 }

◆ Replace() [2/2]

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

staticinherited

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

Parameters

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

Returns: True if aText was modified, otherwise false.

Definition at line 168 of file eda_item.cpp.

{
 wxString text = aText;
 wxString searchText = aSearchData.findString;
 wxString result;
 bool replaced = false;
 
 if( !aSearchData.matchCase )
 {
 text = text.Upper();
 searchText = searchText.Upper();
 }
 
 int ii = 0;
 
 while( ii < (int) text.length() )
 {
 int next = text.find( searchText, ii );
 
 if( next == wxNOT_FOUND )
 {
 result += aText.Mid( ii, wxString::npos );
 break;
 }
 
 if( next > ii )
 result += aText.Mid( ii, next - ii );
 
 ii = next;
 next += searchText.length();
 
 bool startOK;
 bool endOK;
 
 if( aSearchData.matchMode == EDA_SEARCH_MATCH_MODE::WHOLEWORD )
 {
 startOK = ( ii == 0 || !wxIsalnum( text.GetChar( ii - 1 ) ) );
 endOK = ( next == (int) text.length() || !wxIsalnum( text.GetChar( next ) ) );
 }
 else
 {
 startOK = true;
 endOK = true;
 }
 
 if( startOK && endOK )
 {
 result += aSearchData.replaceString;
 replaced = true;
 ii = next;
 }
 else
 {
 result += aText.GetChar( ii );
 ii++;
 }
 }
 
 aText = result;
 return replaced;
}

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

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

◆ Resize()

void SCH_SHEET::Resize ( const wxSize & aSize )

Resize this sheet to aSize and adjust all of the labels accordingly.

Parameters

[in] aSize The new size for this sheet.

Definition at line 899 of file sch_sheet.cpp.

{
 if( aSize == m_size )
 return;
 
 m_size = aSize;
 
 // Move the fields if we're in autoplace mode
 if( m_fieldsAutoplaced == FIELDS_AUTOPLACED_AUTO )
 AutoplaceFields( /* aScreen */ nullptr, /* aManual */ false );
 
 // Move the sheet labels according to the new sheet size.
 for( SCH_SHEET_PIN* sheetPin : m_pins )
 sheetPin->ConstrainOnEdge( sheetPin->GetPosition() );
}

References AutoplaceFields(), FIELDS_AUTOPLACED_AUTO, SCH_ITEM::m_fieldsAutoplaced, m_pins, and m_size.

Referenced by SCH_DRAWING_TOOLS::sizeSheet().

◆ ResolveTextVar()

bool SCH_SHEET::ResolveTextVar	(	wxString *	token,
		int	aDepth = `0`
	)		const

Resolve any references to system tokens supported by the sheet.

Parameters

aDepth is a counter to limit recursion and circular references.

Definition at line 233 of file sch_sheet.cpp.

{
 for( int i = 0; i < SHEET_MANDATORY_FIELDS; ++i )
 {
 if( token->IsSameAs( m_fields[i].GetCanonicalName().Upper() ) )
 {
 *token = m_fields[i].GetShownText( aDepth + 1 );
 return true;
 }
 }
 
 for( size_t i = SHEET_MANDATORY_FIELDS; i < m_fields.size(); ++i )
 {
 if( token->IsSameAs( m_fields[i].GetName() ) )
 {
 *token = m_fields[i].GetShownText( aDepth + 1 );
 return true;
 }
 }
 
 PROJECT *project = &Schematic()->Prj();
 
 // We cannot resolve text variables initially on load as we need to first load the screen and
 // then parse the hierarchy. So skip the resolution if the screen isn't set yet
 if( m_screen && m_screen->GetTitleBlock().TextVarResolver( token, project ) )
 {
 return true;
 }
 
 if( token->IsSameAs( wxT( "#" ) ) )
 {
 *token = wxString::Format( "%s", findSelf().GetPageNumber() );
 return true;
 }
 else if( token->IsSameAs( wxT( "##" ) ) )
 {
 SCH_SHEET_LIST sheetList = Schematic()->GetSheets();
 *token = wxString::Format( wxT( "%d" ), (int) sheetList.size() );
 return true;
 }
 else if( token->IsSameAs( wxT( "SHEETPATH" ) ) )
 {
 *token = findSelf().PathHumanReadable();
 return true;
 }
 else
 {
 // See if any of the sheets up the hierarchy can resolve it:
 
 SCH_SHEET_PATH sheetPath = findSelf();
 
 if( sheetPath.size() >= 2 )
 {
 sheetPath.pop_back();
 
 if( sheetPath.Last()->ResolveTextVar( token, aDepth ) )
 return true;
 }
 }
 
 return false;
}

References findSelf(), Format(), GetPageNumber(), SCHEMATIC::GetSheets(), SCH_SCREEN::GetTitleBlock(), SCH_SHEET_PATH::Last(), m_fields, m_screen, SCH_SHEET_PATH::PathHumanReadable(), SCH_SHEET_PATH::pop_back(), SCHEMATIC::Prj(), project, ResolveTextVar(), SCH_ITEM::Schematic(), SHEET_MANDATORY_FIELDS, SCH_SHEET_PATH::size(), and TITLE_BLOCK::TextVarResolver().

Referenced by SCH_FIELD::GetShownText(), SCH_TEXT::GetShownText(), SCH_TEXTBOX::GetShownText(), SCHEMATIC::ResolveCrossReference(), SCH_LABEL_BASE::ResolveTextVar(), and ResolveTextVar().

◆ Rotate()

void SCH_SHEET::Rotate ( const VECTOR2I & aCenter )

overridevirtual

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

Implements SCH_ITEM.

Definition at line 809 of file sch_sheet.cpp.

{
 VECTOR2I prev = m_pos;
 
 RotatePoint( m_pos, aCenter, ANGLE_90 );
 RotatePoint( &m_size.x, &m_size.y, ANGLE_90 );
 
 if( m_size.x < 0 )
 {
 m_pos.x += m_size.x;
 m_size.x = -m_size.x;
 }
 
 if( m_size.y < 0 )
 {
 m_pos.y += m_size.y;
 m_size.y = -m_size.y;
 }
 
 // Pins must be rotated first as that's how we determine vertical vs horizontal
 // orientation for auto-placement
 for( SCH_SHEET_PIN* sheetPin : m_pins )
 sheetPin->Rotate( aCenter );
 
 if( m_fieldsAutoplaced == FIELDS_AUTOPLACED_AUTO )
 {
 AutoplaceFields( /* aScreen */ nullptr, /* aManual */ false );
 }
 else
 {
 // Move the fields to the new position because the parent itself has moved.
 for( SCH_FIELD& field : m_fields )
 {
 VECTOR2I pos = field.GetTextPos();
 pos.x -= prev.x - m_pos.x;
 pos.y -= prev.y - m_pos.y;
 field.SetTextPos( pos );
 }
 }
}

References ANGLE_90, AutoplaceFields(), FIELDS_AUTOPLACED_AUTO, m_fields, SCH_ITEM::m_fieldsAutoplaced, m_pins, m_pos, m_size, RotatePoint(), VECTOR2< T >::x, and VECTOR2< T >::y.

Referenced by SCH_EDIT_TOOL::Rotate().

◆ RunOnChildren()

void SCH_SHEET::RunOnChildren ( const std::function< void(SCH_ITEM *)> & aFunction )

overridevirtual

Reimplemented from SCH_ITEM.

Definition at line 1027 of file sch_sheet.cpp.

{
 for( SCH_FIELD& field : m_fields )
 aFunction( &field );
 
 for( SCH_SHEET_PIN* pin : m_pins )
 aFunction( pin );
}

References m_fields, m_pins, and pin.

◆ Schematic()

SCHEMATIC * SCH_ITEM::Schematic ( ) const

inherited

Searches the item hierarchy to find a SCHEMATIC.

Every SCH_ITEM that lives on a SCH_SCREEN should be parented to either that screen or another SCH_ITEM on the same screen (for example, pins to their symbols).

Every SCH_SCREEN should be parented to the SCHEMATIC.

Note: This hierarchy is not the same as the sheet hierarchy!

Returns: the parent schematic this item lives on, or nullptr.

Definition at line 112 of file sch_item.cpp.

{
 EDA_ITEM* parent = GetParent();
 
 while( parent )
 {
 if( parent->Type() == SCHEMATIC_T )
 return static_cast<SCHEMATIC*>( parent );
 else
 parent = parent->GetParent();
 }
 
 return nullptr;
}

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

Referenced by SCH_EDIT_TOOL::ChangeTextType(), SCH_ITEM::Connection(), SCH_DRAWING_TOOLS::createSheetPin(), DIALOG_SCH_FIELD_PROPERTIES::DIALOG_SCH_FIELD_PROPERTIES(), findSelf(), SCH_MARKER::GetColorLayer(), SCH_ITEM::GetEffectiveNetClass(), SCH_JUNCTION::getEffectiveShape(), SCH_LABEL_BASE::GetIntersheetRefs(), SCH_LABEL_BASE::GetLabelBoxExpansion(), SCH_DIRECTIVE_LABEL::GetPenWidth(), SCH_LINE::GetPenWidth(), SCH_NO_CONNECT::GetPenWidth(), SCH_SHAPE::GetPenWidth(), GetPenWidth(), SCH_SHEET_PIN::GetPenWidth(), SCH_SYMBOL::GetPins(), SCH_MARKER::GetSeverity(), SCH_FIELD::GetShownText(), SCH_LABEL_BASE::GetShownText(), SCH_TEXT::GetShownText(), SCH_TEXTBOX::GetShownText(), SCH_TEXT::GetTextOffset(), SCH_PIN::HitTest(), IsRootSheet(), SCH_LABEL_BASE::IsType(), DIALOG_SYMBOL_PROPERTIES::OnAddField(), DIALOG_SCH_FIELD_PROPERTIES::onScintillaCharAdded(), DIALOG_TEXT_PROPERTIES::onScintillaCharAdded(), SCH_LABEL_BASE::ResolveTextVar(), SCH_GLOBALLABEL::ResolveTextVar(), ResolveTextVar(), SCH_SYMBOL::ResolveTextVar(), SCH_SYMBOL::SetFootprint(), SCH_SYMBOL::SetRef(), SCH_SYMBOL::SetValue(), DIALOG_LABEL_PROPERTIES::TransferDataFromWindow(), DIALOG_LABEL_PROPERTIES::TransferDataToWindow(), DIALOG_SCH_FIELD_PROPERTIES::UpdateField(), and SCH_MARKER::ViewGetLayers().

◆ SearchHierarchy()

bool SCH_SHEET::SearchHierarchy	(	const wxString &	aFilename,
		SCH_SCREEN **	aScreen
	)

Search the existing hierarchy for an instance of screen loaded from aFileName.

Parameters

aFilename	The filename to find (MUST be absolute, and in wxPATH_NATIVE encoding).
aScreen	A location to return a pointer to the screen (if found).

Returns: true if found, and a pointer to the screen

Definition at line 707 of file sch_sheet.cpp.

{
 if( m_screen )
 {
 // Only check the root sheet once and don't recurse.
 if( !GetParent() )
 {
 if( m_screen && m_screen->GetFileName().Cmp( aFilename ) == 0 )
 {
 *aScreen = m_screen;
 return true;
 }
 }
 
 for( SCH_ITEM* aItem : m_screen->Items().OfType( SCH_SHEET_T ) )
 {
 SCH_SHEET* sheet = static_cast<SCH_SHEET*>( aItem );
 SCH_SCREEN* screen = sheet->m_screen;
 
 // Must use the screen's path (which is always absolute) rather than the
 // sheet's (which could be relative).
 if( screen && screen->GetFileName().Cmp( aFilename ) == 0 )
 {
 *aScreen = screen;
 return true;
 }
 
 if( sheet->SearchHierarchy( aFilename, aScreen ) )
 return true;
 }
 }
 
 return false;
}

References SCH_SCREEN::GetFileName(), EDA_ITEM::GetParent(), SCH_SCREEN::Items(), m_screen, EE_RTREE::OfType(), SCH_SHEET_T, and SearchHierarchy().

Referenced by SCH_SEXPR_PLUGIN::loadHierarchy(), SCH_LEGACY_PLUGIN::loadHierarchy(), DIALOG_SHEET_PROPERTIES::onSheetFilenameChanged(), SCH_EDITOR_CONTROL::Paste(), and SearchHierarchy().

◆ Set() [1/3]

template<typename T >

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

inlineinherited

Definition at line 66 of file inspectable.h.

 {
 PROPERTY_MANAGER& propMgr = PROPERTY_MANAGER::Instance();
 TYPE_ID thisType = TYPE_HASH( *this );
 PROPERTY_BASE* prop = propMgr.GetProperty( thisType, aProperty );
 void* object = nullptr;
 
 if( prop )
 {
 object = propMgr.TypeCast( this, thisType, prop->OwnerHash() );
 
 if( object )
 prop->set<T>( object, aValue );
 }
 
 return object != nullptr;
 }

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

◆ Set() [2/3]

template<typename T >

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

inlineinherited

Definition at line 54 of file inspectable.h.

 {
 PROPERTY_MANAGER& propMgr = PROPERTY_MANAGER::Instance();
 void* object = propMgr.TypeCast( this, TYPE_HASH( *this ), aProperty->OwnerHash() );
 
 if( object )
 aProperty->set<T>( object, aValue );
 
 return object != nullptr;
 }

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

◆ Set() [3/3]

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

inlineinherited

Definition at line 42 of file inspectable.h.

 {
 PROPERTY_MANAGER& propMgr = PROPERTY_MANAGER::Instance();
 void* object = propMgr.TypeCast( this, TYPE_HASH( *this ), aProperty->OwnerHash() );
 
 if( object )
 aProperty->setter( object, aValue );
 
 return object != nullptr;
 }

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

Referenced by PCB_PROPERTIES_PANEL::valueChanged().

◆ SetBackgroundColor()

void SCH_SHEET::SetBackgroundColor ( KIGFX::COLOR4D aColor )

inline

Definition at line 115 of file sch_sheet.h.

115{ m_backgroundColor = aColor; }

References m_backgroundColor.

Referenced by SCH_DRAWING_TOOLS::DrawSheet(), SCH_ALTIUM_PLUGIN::ParseHarnessConnector(), SCH_ALTIUM_PLUGIN::ParseSheetSymbol(), DIALOG_SHEET_PROPERTIES::TransferDataFromWindow(), and DIALOG_GLOBAL_EDIT_TEXT_AND_GRAPHICS::visitItem().

◆ SetBorderColor()

void SCH_SHEET::SetBorderColor ( KIGFX::COLOR4D aColor )

inline

Definition at line 112 of file sch_sheet.h.

112{ m_borderColor = aColor; }

References m_borderColor.

Referenced by SCH_DRAWING_TOOLS::DrawSheet(), SCH_ALTIUM_PLUGIN::ParseHarnessConnector(), SCH_ALTIUM_PLUGIN::ParseSheetSymbol(), DIALOG_SHEET_PROPERTIES::TransferDataFromWindow(), and DIALOG_GLOBAL_EDIT_TEXT_AND_GRAPHICS::visitItem().

◆ SetBorderWidth()

void SCH_SHEET::SetBorderWidth ( int aWidth )

inline

Definition at line 109 of file sch_sheet.h.

109{ m_borderWidth = aWidth; }

References m_borderWidth.

Referenced by SCH_DRAWING_TOOLS::DrawSheet(), DIALOG_SHEET_PROPERTIES::TransferDataFromWindow(), and DIALOG_GLOBAL_EDIT_TEXT_AND_GRAPHICS::visitItem().

◆ SetBrightened()

void EDA_ITEM::SetBrightened ( )

inlineinherited

Definition at line 119 of file eda_item.h.

119{ SetFlags( BRIGHTENED ); }

EDA_ITEM::SetFlags

void SetFlags(EDA_ITEM_FLAGS aMask)

Definition: eda_item.h:142

References BRIGHTENED, and EDA_ITEM::SetFlags().

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

◆ SetConnectivityDirty()

void SCH_ITEM::SetConnectivityDirty ( bool aDirty = true )

inlineinherited

Definition at line 415 of file sch_item.h.

415{ m_connectivity_dirty = aDirty; }

References SCH_ITEM::m_connectivity_dirty.

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

◆ SetFields()

void SCH_SHEET::SetFields ( const std::vector< SCH_FIELD > & aFields )

Set multiple schematic fields.

Parameters

aFields are the fields to set in this symbol.

Definition at line 331 of file sch_sheet.cpp.

{
 m_fields = aFields;
 int next_id = SHEET_MANDATORY_FIELDS;
 
 for( int ii = 0; ii < int( m_fields.size() ); )
 {
 if( m_fields[ii].GetId() < 0 || m_fields[ii].GetId() >= ssize_t( m_fields.size() ) )
 m_fields[ii].SetId( next_id++ );
 
 if( m_fields[ii].GetId() != ii )
 std::swap( m_fields[ii], m_fields[m_fields[ii].GetId()]);
 
 if( m_fields[ii].GetId() == ii )
 ++ii;
 }
 
 // Make sure that we get the UNIX variant of the file path
 SetFileName( m_fields[SHEETFILENAME].GetText() );
}

References EDA_UNIT_UTILS::GetText(), m_fields, SetFileName(), SHEET_MANDATORY_FIELDS, and SHEETFILENAME.

Referenced by CADSTAR_SCH_ARCHIVE_LOADER::loadChildSheets(), DIALOG_SHEET_PROPERTIES::OnUpdateUI(), and DIALOG_SHEET_PROPERTIES::TransferDataFromWindow().

◆ SetFieldsAutoplaced()

void SCH_ITEM::SetFieldsAutoplaced ( )

inlineinherited

Definition at line 426 of file sch_item.h.

426{ m_fieldsAutoplaced = FIELDS_AUTOPLACED_AUTO; }

References FIELDS_AUTOPLACED_AUTO, and SCH_ITEM::m_fieldsAutoplaced.

Referenced by SCH_SEXPR_PARSER::parseSchText().

◆ SetFileName()

void SCH_SHEET::SetFileName ( const wxString & aFilename )

inline

Definition at line 305 of file sch_sheet.h.

 {
 // Filenames are stored using unix notation
 wxString tmp = aFilename;
 tmp.Replace( wxT( "\\" ), wxT( "/" ) );
 m_fields[ SHEETFILENAME ].SetText( tmp );
 }

References m_fields, and SHEETFILENAME.

Referenced by SCH_EDIT_FRAME::importFile(), SCH_ALTIUM_PLUGIN::Load(), CADSTAR_SCH_ARCHIVE_PLUGIN::Load(), SCH_EAGLE_PLUGIN::Load(), SCH_EDIT_FRAME::LoadSheetFromFile(), SCH_SHEET_PATH::MakeFilePathRelativeToParentSheet(), SCH_EDIT_FRAME::SaveProject(), and SetFields().

◆ SetFlags()

void EDA_ITEM::SetFlags ( EDA_ITEM_FLAGS aMask )

inlineinherited

Definition at line 142 of file eda_item.h.

142{ m_flags |= aMask; }

References EDA_ITEM::m_flags.

◆ SetForceVisible()

void EDA_ITEM::SetForceVisible ( bool aEnable )

inlineinherited

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

Parameters

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

Definition at line 201 of file eda_item.h.

201{ m_forceVisible = aEnable; }

References EDA_ITEM::m_forceVisible.

Referenced by SCH_EDITOR_CONTROL::UpdateFind().

◆ SetInstances()

void SCH_SHEET::SetInstances ( const std::vector< SCH_SHEET_INSTANCE > & aInstances )

inline

Definition at line 380 of file sch_sheet.h.

 {
 m_instances = aInstances;
 }

References m_instances.

◆ SetIsShownAsBitmap()

void EDA_ITEM::SetIsShownAsBitmap ( bool aBitmap )

inlineinherited

Definition at line 167 of file eda_item.h.

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

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

◆ SetLastResolvedState()

virtual void SCH_ITEM::SetLastResolvedState ( const SCH_ITEM * aItem )

inlinevirtualinherited

Reimplemented in SCH_BUS_ENTRY_BASE, SCH_FIELD, SCH_JUNCTION, SCH_LABEL_BASE, and SCH_LINE.

Definition at line 417 of file sch_item.h.

417{ }

Referenced by SCH_EDITOR_CONTROL::Paste().

◆ SetLayer()

void SCH_ITEM::SetLayer ( SCH_LAYER_ID aLayer )

inlineinherited

Set the layer this item is on.

Parameters

aLayer The layer number.

Definition at line 253 of file sch_item.h.

253{ m_layer = aLayer; }

References SCH_ITEM::m_layer.

Referenced by PANEL_EESCHEMA_COLOR_SETTINGS::createPreviewItems(), CADSTAR_SCH_ARCHIVE_LOADER::loadBusses(), CADSTAR_SCH_ARCHIVE_LOADER::loadGraphicStaightSegment(), CADSTAR_SCH_ARCHIVE_LOADER::loadNets(), SCH_NO_CONNECT::SCH_NO_CONNECT(), SCH_SHAPE::SCH_SHAPE(), and SCH_FIELD::SetId().

◆ SetLocked()

virtual void SCH_ITEM::SetLocked ( bool aLocked )

inlinevirtualinherited

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

Definition at line 234 of file sch_item.h.

234{}

◆ SetModified()

void EDA_ITEM::SetModified ( )

inherited

Definition at line 64 of file eda_item.cpp.

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

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

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

◆ SetPageNumber()

void SCH_SHEET::SetPageNumber	(	const SCH_SHEET_PATH &	aInstance,
		const wxString &	aPageNumber
	)

Set the page number for the sheet instance aInstance.

Warning: The SCH_SHEET_PATH object must be a full hierarchical path which means the SCH_SHEET object at index 0 must be the root sheet. A partial sheet path will raise an assertion on debug builds and silently fail and return on release builds.

Parameters

[in]	aInstance	is the hierarchical path of the sheet.
[in]	aReference	is the new page number for the sheet.

Definition at line 1250 of file sch_sheet.cpp.

{
 wxCHECK( aSheetPath.IsFullPath(), /* void */ );
 
 KIID_PATH path = aSheetPath.Path();
 
 for( SCH_SHEET_INSTANCE& instance : m_instances )
 {
 if( instance.m_Path == path )
 {
 instance.m_PageNumber = aPageNumber;
 break;
 }
 }
}

References SCH_SHEET_PATH::IsFullPath(), m_instances, SCH_SHEET_PATH::Path(), and path.

Referenced by SCH_EDIT_FRAME::CreateScreens(), SCH_DRAWING_TOOLS::DrawSheet(), SCH_ALTIUM_PLUGIN::Load(), SCH_EAGLE_PLUGIN::loadSchematic(), CADSTAR_SCH_ARCHIVE_LOADER::loadSheetAndChildSheets(), CADSTAR_SCH_ARCHIVE_LOADER::loadSheets(), SCH_ALTIUM_PLUGIN::ParseHarnessConnector(), SCH_ALTIUM_PLUGIN::ParseParameter(), SCH_ALTIUM_PLUGIN::ParseSheetSymbol(), SCH_SHEET_LIST::SetInitialPageNumbers(), SCH_SHEET_PATH::SetPageNumber(), DIALOG_SHEET_PROPERTIES::TransferDataFromWindow(), SCH_EDITOR_CONTROL::updatePastedSheet(), and SCH_SHEET_LIST::UpdateSheetInstances().

◆ SetParent()

virtual void EDA_ITEM::SetParent ( EDA_ITEM * aParent )

inlinevirtualinherited

Reimplemented in LIB_SYMBOL, and PCB_DIMENSION_BASE.

Definition at line 100 of file eda_item.h.

100{ m_parent = aParent; }

References EDA_ITEM::m_parent.

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

◆ SetPosition()

void SCH_SHEET::SetPosition ( const VECTOR2I & aPosition )

overridevirtual

Reimplemented from EDA_ITEM.

Definition at line 891 of file sch_sheet.cpp.

{
 // Remember the sheet and all pin sheet positions must be
 // modified. So use Move function to do that.
 Move( aPosition - m_pos );
}

References m_pos, and Move().

Referenced by TEST_EE_ITEM_FIXTURE::TEST_EE_ITEM_FIXTURE(), and EE_POINT_EDITOR::updateParentItem().

◆ SetScreen()

void SCH_SHEET::SetScreen ( SCH_SCREEN * aScreen )

Set the SCH_SCREEN associated with this sheet to aScreen.

The screen reference counting is performed by SetScreen. If aScreen is not the same as the current screen, the current screen reference count is decremented and aScreen becomes the screen for the sheet. If the current screen reference count reaches zero, the current screen is deleted. NULL is a valid value for aScreen.

Parameters

aScreen The new screen to associate with the sheet.

Definition at line 162 of file sch_sheet.cpp.

{
 if( aScreen == m_screen )
 return;
 
 if( m_screen != nullptr )
 {
 m_screen->DecRefCount();
 
 if( m_screen->GetRefCount() == 0 )
 {
 delete m_screen;
 m_screen = nullptr;
 }
 }
 
 m_screen = aScreen;
 
 if( m_screen )
 m_screen->IncRefCount();
}

References SCH_SCREEN::DecRefCount(), SCH_SCREEN::GetRefCount(), SCH_SCREEN::IncRefCount(), and m_screen.

Referenced by SCH_EDIT_FRAME::CreateScreens(), SCH_DRAWING_TOOLS::DrawSheet(), SCH_EDIT_FRAME::InitSheet(), SCH_ALTIUM_PLUGIN::Load(), CADSTAR_SCH_ARCHIVE_PLUGIN::Load(), SCH_EAGLE_PLUGIN::Load(), SCH_SEXPR_PLUGIN::loadHierarchy(), SCH_LEGACY_PLUGIN::loadHierarchy(), CADSTAR_SCH_ARCHIVE_LOADER::loadSheetAndChildSheets(), SCH_EDIT_FRAME::LoadSheetFromFile(), DIALOG_SHEET_PROPERTIES::onSheetFilenameChanged(), SCH_ALTIUM_PLUGIN::ParseHarnessConnector(), SCH_ALTIUM_PLUGIN::ParseSheetSymbol(), and SCH_EDITOR_CONTROL::Paste().

◆ SetSelected()

void EDA_ITEM::SetSelected ( )

inlineinherited

Definition at line 118 of file eda_item.h.

118{ SetFlags( SELECTED ); }

References SELECTED, and EDA_ITEM::SetFlags().

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

◆ SetSize()

void SCH_SHEET::SetSize ( const wxSize & aSize )

inline

Definition at line 106 of file sch_sheet.h.

106{ m_size = aSize; }

References m_size.

Referenced by SCH_MOVE_TOOL::AlignElements(), TEST_EE_ITEM_FIXTURE::TEST_EE_ITEM_FIXTURE(), and EE_POINT_EDITOR::updateParentItem().

◆ SetState()

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

inlineinherited

Definition at line 131 of file eda_item.h.

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

References EDA_ITEM::m_status.

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

◆ SetStatus()

void EDA_ITEM::SetStatus ( EDA_ITEM_FLAGS aStatus )

inlineinherited

Definition at line 140 of file eda_item.h.

140{ m_status = aStatus; }

References EDA_ITEM::m_status.

Referenced by BOARD_NETLIST_UPDATER::UpdateNetlist().

◆ SetStoredPos()

void SCH_ITEM::SetStoredPos ( const VECTOR2I & aPos )

inlineinherited

Definition at line 210 of file sch_item.h.

210{ m_storedPos = aPos; }

References SCH_ITEM::m_storedPos.

Referenced by SCH_MOVE_TOOL::Main().

◆ SetStroke()

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

inlinevirtualinherited

Reimplemented in SCH_BUS_ENTRY_BASE, SCH_LINE, and SCH_SHAPE.

Definition at line 459 of file sch_item.h.

459{ wxCHECK( false, /* void */ ); }

Referenced by DIALOG_GLOBAL_EDIT_TEXT_AND_GRAPHICS::processItem().

◆ SetWireImage()

void EDA_ITEM::SetWireImage ( )

inlineinherited

Definition at line 117 of file eda_item.h.

117{ SetFlags( IS_WIRE_IMAGE ); }

References IS_WIRE_IMAGE, and EDA_ITEM::SetFlags().

◆ Sort()

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

inlinestaticinherited

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

Parameters

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

Returns: True if aLeft is less than aRight.

Definition at line 438 of file eda_item.h.

438{ return *aLeft < *aRight; }

◆ SwapData()

void SCH_SHEET::SwapData ( SCH_ITEM * aItem )

overridevirtual

Swap the internal data structures aItem with the schematic item.

Obviously, aItem must have the same type than me.

Parameters

aItem The item to swap the data structures with.

Reimplemented from SCH_ITEM.

Definition at line 297 of file sch_sheet.cpp.

{
 wxCHECK_RET( aItem->Type() == SCH_SHEET_T,
 wxString::Format( wxT( "SCH_SHEET object cannot swap data with %s object." ),
 aItem->GetClass() ) );
 
 SCH_SHEET* sheet = ( SCH_SHEET* ) aItem;
 
 std::swap( m_pos, sheet->m_pos );
 std::swap( m_size, sheet->m_size );
 m_fields.swap( sheet->m_fields );
 std::swap( m_fieldsAutoplaced, sheet->m_fieldsAutoplaced );
 m_pins.swap( sheet->m_pins );
 
 // Update parent pointers after swapping.
 for( SCH_SHEET_PIN* sheetPin : m_pins )
 sheetPin->SetParent( this );
 
 for( SCH_SHEET_PIN* sheetPin : sheet->m_pins )
 sheetPin->SetParent( sheet );
 
 for( SCH_FIELD& field : m_fields )
 field.SetParent( this );
 
 for( SCH_FIELD& field : sheet->m_fields )
 field.SetParent( sheet );
 
 std::swap( m_borderWidth, sheet->m_borderWidth );
 std::swap( m_borderColor, sheet->m_borderColor );
 std::swap( m_backgroundColor, sheet->m_backgroundColor );
 std::swap( m_instances, sheet->m_instances );
}

References Format(), SCH_ITEM::GetClass(), m_backgroundColor, m_borderColor, m_borderWidth, m_fields, SCH_ITEM::m_fieldsAutoplaced, m_instances, m_pins, m_pos, m_size, SCH_SHEET_T, EDA_ITEM::SetParent(), and EDA_ITEM::Type().

◆ SymbolCount()

int SCH_SHEET::SymbolCount ( ) const

Count our own symbols, without the power symbols.

Definition at line 685 of file sch_sheet.cpp.

{
 int n = 0;
 
 if( m_screen )
 {
 for( SCH_ITEM* aItem : m_screen->Items().OfType( SCH_SYMBOL_T ) )
 {
 SCH_SYMBOL* symbol = (SCH_SYMBOL*) aItem;
 
 if( symbol->GetField( VALUE_FIELD )->GetText().GetChar( 0 ) != '#' )
 n++;
 }
 
 for( SCH_ITEM* aItem : m_screen->Items().OfType( SCH_SHEET_T ) )
 n += static_cast<const SCH_SHEET*>( aItem )->SymbolCount();
 }
 
 return n;
}

References SCH_SYMBOL::GetField(), EDA_TEXT::GetText(), SCH_SCREEN::Items(), m_screen, EE_RTREE::OfType(), SCH_SHEET_T, SCH_SYMBOL_T, SymbolCount(), and VALUE_FIELD.

Referenced by SymbolCount().

◆ Type()

KICAD_T EDA_ITEM::Type ( ) const

inlineinherited

Returns the type of object.

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

Returns: the type of object.

Definition at line 97 of file eda_item.h.

97{ return m_structType; }

EDA_ITEM::m_structType

KICAD_T m_structType

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

Definition: eda_item.h:505

References EDA_ITEM::m_structType.

◆ UpdateDanglingState()

bool SCH_SHEET::UpdateDanglingState	(	std::vector< DANGLING_END_ITEM > &	aItemList,
		const SCH_SHEET_PATH *	aPath = `nullptr`
	)

overridevirtual

Test the schematic item to aItemList to check if it's dangling state has changed.

Note that the return value only true when the state of the test has changed. Use the IsDangling() method to get the current dangling state of the item. Some of the schematic objects cannot be tested for a dangling state, the default method always returns false. Only override the method if the item can be tested for a dangling state.

If aSheet is passed a non-null pointer to a SCH_SHEET_PATH, the overridden method can optionally use it to update sheet-local connectivity information

Parameters

aItemList	is the list of items to test item against.
aSheet	is the sheet path to update connections for.

Returns: True if the dangling state has changed from it's current setting.

Reimplemented from SCH_ITEM.

Definition at line 967 of file sch_sheet.cpp.

{
 bool changed = false;
 
 for( SCH_SHEET_PIN* sheetPin : m_pins )
 changed |= sheetPin->UpdateDanglingState( aItemList );
 
 return changed;
}

References m_pins.

◆ ViewBBox()

const BOX2I EDA_ITEM::ViewBBox ( ) const

overridevirtualinherited

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

Returns: the current bounding box.

Implements KIGFX::VIEW_ITEM.

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

Definition at line 254 of file eda_item.cpp.

{
 // Basic fallback
 return GetBoundingBox();
}

References EDA_ITEM::GetBoundingBox().

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

◆ ViewDraw()

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

inlinevirtualinherited

Draw the parts of the object belonging to layer aLayer.

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

Parameters

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

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

Definition at line 106 of file view_item.h.

107 {}

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

◆ ViewGetLayers()

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

overridevirtual

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

Reimplemented from SCH_ITEM.

Definition at line 633 of file sch_sheet.cpp.

{
 aCount = 7;
 aLayers[0] = LAYER_HIERLABEL;
 aLayers[1] = LAYER_SHEETNAME;
 aLayers[2] = LAYER_SHEETFILENAME;
 aLayers[3] = LAYER_SHEETFIELDS;
 aLayers[4] = LAYER_SHEET;
 aLayers[5] = LAYER_SHEET_BACKGROUND;
 aLayers[6] = LAYER_SELECTION_SHADOWS;
}

References LAYER_HIERLABEL, LAYER_SELECTION_SHADOWS, LAYER_SHEET, LAYER_SHEET_BACKGROUND, LAYER_SHEETFIELDS, LAYER_SHEETFILENAME, and LAYER_SHEETNAME.

◆ ViewGetLOD()

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

inlinevirtualinherited

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

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

Parameters

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

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

Reimplemented in GERBER_DRAW_ITEM, PCB_GROUP, FOOTPRINT, FP_SHAPE, FP_TEXT, FP_TEXTBOX, PAD, PCB_BITMAP, PCB_SHAPE, PCB_TEXT, PCB_TEXTBOX, PCB_TRACK, PCB_VIA, ZONE, and FP_ZONE.

Definition at line 132 of file view_item.h.

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

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

◆ viewPrivData()

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

inlineinherited

◆ Visit()

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

overridevirtual

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

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

Parameters

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

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

Reimplemented from EDA_ITEM.

Definition at line 990 of file sch_sheet.cpp.

{
 for( KICAD_T scanType : aScanTypes )
 {
 // If caller wants to inspect my type
 if( scanType == SCH_LOCATE_ANY_T || scanType == Type() )
 {
 if( INSPECT_RESULT::QUIT == aInspector( this, nullptr ) )
 return INSPECT_RESULT::QUIT;
 }
 
 if( scanType == SCH_LOCATE_ANY_T || scanType == SCH_FIELD_T )
 {
 // Test the sheet fields.
 for( SCH_FIELD& field : m_fields )
 {
 if( INSPECT_RESULT::QUIT == aInspector( &field, this ) )
 return INSPECT_RESULT::QUIT;
 }
 }
 
 if( scanType == SCH_LOCATE_ANY_T || scanType == SCH_SHEET_PIN_T )
 {
 // Test the sheet labels.
 for( SCH_SHEET_PIN* sheetPin : m_pins )
 {
 if( INSPECT_RESULT::QUIT == aInspector( sheetPin, this ) )
 return INSPECT_RESULT::QUIT;
 }
 }
 }
 
 return INSPECT_RESULT::CONTINUE;
}

References CONTINUE, m_fields, m_pins, QUIT, SCH_FIELD_T, SCH_LOCATE_ANY_T, SCH_SHEET_PIN_T, and EDA_ITEM::Type().

Friends And Related Function Documentation

◆ SCH_SHEET_PIN

friend class SCH_SHEET_PIN

friend

Definition at line 459 of file sch_sheet.h.

Referenced by operator=(), and SCH_SHEET().

Member Data Documentation

◆ m_backgroundColor

KIGFX::COLOR4D SCH_SHEET::m_backgroundColor

private

Definition at line 473 of file sch_sheet.h.

Referenced by GetBackgroundColor(), SCH_SHEET(), SetBackgroundColor(), and SwapData().

◆ m_borderColor

KIGFX::COLOR4D SCH_SHEET::m_borderColor

private

Definition at line 472 of file sch_sheet.h.

Referenced by GetBorderColor(), SCH_SHEET(), SetBorderColor(), and SwapData().

◆ m_borderWidth

int SCH_SHEET::m_borderWidth

private

Definition at line 471 of file sch_sheet.h.

Referenced by GetBorderWidth(), SCH_SHEET(), SetBorderWidth(), and SwapData().

◆ m_connected_items

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

protectedinherited

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

Definition at line 498 of file sch_item.h.

Referenced by SCH_ITEM::AddConnectionTo(), SCH_ITEM::ConnectedItems(), and SCH_LABEL_BASE::IsType().

◆ m_connection_map

std::unordered_map<SCH_SHEET_PATH, SCH_CONNECTION*> SCH_ITEM::m_connection_map

protectedinherited

Store connectivity information, per sheet.

Definition at line 501 of file sch_item.h.

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

◆ m_connections

EDA_ITEMS SCH_ITEM::m_connections

protectedinherited

Definition at line 492 of file sch_item.h.

Referenced by SCH_ITEM::ClearConnections(), and SCH_ITEM::~SCH_ITEM().

◆ m_connectivity_dirty

bool SCH_ITEM::m_connectivity_dirty

protectedinherited

Definition at line 503 of file sch_item.h.

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

◆ m_fields

std::vector<SCH_FIELD> SCH_SHEET::m_fields

private

Definition at line 467 of file sch_sheet.h.

Referenced by AutoplaceFields(), GetBoundingBox(), GetContextualTextVars(), GetFields(), GetFileName(), GetMsgPanelInfo(), GetName(), GetSelectMenuText(), MirrorHorizontally(), MirrorVertically(), Move(), operator<(), operator=(), Plot(), Print(), ResolveTextVar(), Rotate(), RunOnChildren(), SCH_SHEET(), SetFields(), SetFileName(), SwapData(), and Visit().

◆ m_fieldsAutoplaced

FIELDS_AUTOPLACED SCH_ITEM::m_fieldsAutoplaced

protectedinherited

Definition at line 493 of file sch_item.h.

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

◆ m_flags

EDA_ITEM_FLAGS EDA_ITEM::m_flags

protectedinherited

Definition at line 498 of file eda_item.h.

Referenced by EDA_ITEM::ClearFlags(), LIB_TEXT::Clone(), DS_DRAW_ITEM_BASE::DS_DRAW_ITEM_BASE(), EDA_ITEM::GetEditFlags(), EDA_ITEM::GetFlags(), PCB_TRACK::GetMsgPanelInfoBase_Common(), SCH_LINE::GetSelectedPoints(), EDA_ITEM::HasFlag(), LIB_ITEM::HitTest(), LIB_SHAPE::HitTest(), LIB_TEXT::HitTest(), SCH_JUNCTION::HitTest(), SCH_LINE::HitTest(), SCH_SYMBOL::HitTest(), LIB_PIN::HitTest(), SCH_PIN::HitTest(), ZONE::InitDataFromSrcInCopyCtor(), EDA_ITEM::IsBrightened(), SCH_ITEM::IsConnected(), EDA_ITEM::IsDragging(), EDA_ITEM::IsEntered(), EDA_ITEM::IsModified(), EDA_ITEM::IsMoving(), EDA_ITEM::IsNew(), EDA_ITEM::IsResized(), EDA_ITEM::IsRollover(), EDA_ITEM::IsSelected(), EDA_ITEM::IsShownAsBitmap(), EDA_ITEM::IsWireImage(), SCH_LINE::MirrorHorizontally(), SCH_LINE::MirrorVertically(), EDA_ITEM::operator=(), SCH_LINE::Rotate(), EDA_ITEM::SetFlags(), and PCB_SHAPE::SwapData().

◆ m_forceVisible

bool EDA_ITEM::m_forceVisible

protectedinherited

Definition at line 497 of file eda_item.h.

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

◆ m_instances

std::vector<SCH_SHEET_INSTANCE> SCH_SHEET::m_instances

private

Definition at line 475 of file sch_sheet.h.

Referenced by AddInstance(), GetInstances(), GetPageNumber(), operator=(), SCH_SHEET(), SetInstances(), SetPageNumber(), and SwapData().

◆ m_layer

SCH_LAYER_ID SCH_ITEM::m_layer

protectedinherited

Definition at line 491 of file sch_item.h.

Referenced by SCH_ITEM::CanConnect(), SCH_LINE::CanConnect(), SCH_LINE::doIsConnected(), SCH_ITEM::GetLayer(), SCH_LINE::GetMenuImage(), SCH_LINE::GetPenWidth(), SCH_LINE::GetSelectMenuText(), SCH_SYMBOL::Init(), SCH_LINE::IsConnectable(), SCH_ITEM::IsType(), SCH_LINE::IsType(), SCH_ITEM::operator=(), SCH_BUS_ENTRY_BASE::Plot(), SCH_LABEL_BASE::Plot(), SCH_TEXT::Plot(), SCH_TEXTBOX::Plot(), SCH_BUS_ENTRY_BASE::Print(), SCH_FIELD::Print(), SCH_LABEL_BASE::Print(), SCH_TEXT::Print(), SCH_TEXTBOX::Print(), SCH_BITMAP::SCH_BITMAP(), SCH_BUS_BUS_ENTRY::SCH_BUS_BUS_ENTRY(), SCH_BUS_WIRE_ENTRY::SCH_BUS_WIRE_ENTRY(), SCH_DIRECTIVE_LABEL::SCH_DIRECTIVE_LABEL(), SCH_GLOBALLABEL::SCH_GLOBALLABEL(), SCH_HIERLABEL::SCH_HIERLABEL(), SCH_ITEM::SCH_ITEM(), SCH_JUNCTION::SCH_JUNCTION(), SCH_LABEL::SCH_LABEL(), SCH_LINE::SCH_LINE(), SCH_PIN::SCH_PIN(), SCH_SHEET(), SCH_SHEET_PIN::SCH_SHEET_PIN(), SCH_TEXT::SCH_TEXT(), SCH_TEXTBOX::SCH_TEXTBOX(), SCH_ITEM::SetLayer(), SCH_FIELD::SwapData(), SCH_LINE::SwapData(), SCH_SHAPE::SwapData(), SCH_TEXT::SwapData(), SCH_TEXTBOX::SwapData(), SCH_JUNCTION::ViewGetLayers(), SCH_LINE::ViewGetLayers(), and SCH_TEXT::ViewGetLayers().

◆ m_parent

EDA_ITEM* EDA_ITEM::m_parent

protectedinherited

Linked list: Link (parent struct)

Definition at line 496 of file eda_item.h.

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

◆ m_pins

std::vector<SCH_SHEET_PIN*> SCH_SHEET::m_pins

private

Definition at line 466 of file sch_sheet.h.

Referenced by AddPin(), CleanupSheet(), doIsConnected(), GetConnectionPoints(), GetEndPoints(), GetMinHeight(), GetMinWidth(), GetPin(), GetPins(), HasPin(), HasPins(), HasUndefinedPins(), IsVerticalOrientation(), MirrorHorizontally(), MirrorVertically(), Move(), operator=(), Plot(), Print(), RemovePin(), renumberPins(), Resize(), Rotate(), RunOnChildren(), SCH_SHEET(), SwapData(), UpdateDanglingState(), Visit(), and ~SCH_SHEET().

◆ m_pos

VECTOR2I SCH_SHEET::m_pos

private

Definition at line 469 of file sch_sheet.h.

Referenced by AutoplaceFields(), SCH_SHEET_PIN::ConstrainOnEdge(), GetBodyBoundingBox(), GetMinHeight(), GetMinWidth(), GetPosition(), GetRotationCenter(), MirrorHorizontally(), MirrorVertically(), Move(), operator=(), Plot(), Print(), Rotate(), SCH_SHEET(), SetPosition(), SCH_SHEET_PIN::SetSide(), and SwapData().

◆ m_screen

SCH_SCREEN* SCH_SHEET::m_screen

private

Definition at line 462 of file sch_sheet.h.

Referenced by CleanupSheet(), CountSheets(), GetContextualTextVars(), GetScreen(), GetScreenCount(), HasUndefinedPins(), LocatePathOfScreen(), ResolveTextVar(), SCH_SHEET(), SearchHierarchy(), SetScreen(), SymbolCount(), and ~SCH_SHEET().

◆ m_size

wxSize SCH_SHEET::m_size

private

Definition at line 470 of file sch_sheet.h.

Referenced by AutoplaceFields(), SCH_SHEET_PIN::ConstrainOnEdge(), GetBodyBoundingBox(), GetMinHeight(), GetMinWidth(), GetRotationCenter(), GetSize(), MirrorHorizontally(), MirrorVertically(), operator=(), Plot(), Print(), Resize(), Rotate(), SCH_SHEET(), SCH_SHEET_PIN::SetSide(), SetSize(), and SwapData().

◆ m_status

EDA_ITEM_FLAGS EDA_ITEM::m_status

protectedinherited

Definition at line 495 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_storedPos

VECTOR2I SCH_ITEM::m_storedPos

protectedinherited

Definition at line 494 of file sch_item.h.

Referenced by SCH_ITEM::GetStoredPos(), and SCH_ITEM::SetStoredPos().

◆ m_structType

KICAD_T EDA_ITEM::m_structType

privateinherited

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

See comment near SetType() regarding virtual functions.

Definition at line 505 of file eda_item.h.

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

◆ m_Uuid

const KIID EDA_ITEM::m_Uuid

inherited

Definition at line 492 of file eda_item.h.

◆ m_viewPrivData

VIEW_ITEM_DATA* KIGFX::VIEW_ITEM::m_viewPrivData

privateinherited

Definition at line 151 of file view_item.h.

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

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

Public Member Functions

Static Public Member Functions

Public Attributes

Protected Member Functions

Protected Attributes

Private Member Functions

Private Attributes

Friends

Detailed Description

Constructor & Destructor Documentation

◆ SCH_SHEET() [1/2]

◆ SCH_SHEET() [2/2]

◆ ~SCH_SHEET()

Member Function Documentation

◆ AddConnectionTo()

◆ AddInstance()

◆ AddPin()

◆ AutoAutoplaceFields()

◆ AutoplaceFields()

◆ CanConnect()

◆ ClassOf()

◆ CleanupSheet()

◆ ClearBrightened()

◆ ClearCaches()

◆ ClearConnections()

◆ ClearEditFlags()

◆ ClearFieldsAutoplaced()

◆ ClearFlags()

◆ ClearSelected()

◆ ClearTempFlags()

◆ ClearViewPrivData()

◆ Clone()

◆ ComparePageNum()

◆ ConnectedItems()

◆ Connection()

◆ ConnectionPropagatesTo()

◆ CountSheets()

◆ DoHypertextAction()

◆ doIsConnected()

◆ Duplicate()

◆ findSelf()

◆ Get() [1/3]

◆ Get() [2/3]

◆ Get() [3/3]

◆ GetBackgroundColor()

◆ GetBodyBoundingBox()

◆ GetBorderColor()

◆ GetBorderWidth()

◆ GetBoundingBox()

◆ GetClass()

◆ GetConnectionPoints()

◆ GetContextualTextVars()

◆ GetDefaultFieldName()

◆ GetDefaultFont()

◆ GetEditFlags()

◆ GetEffectiveNetClass()

◆ GetEndPoints()

◆ GetFields() [1/2]

◆ GetFields() [2/2]

◆ GetFieldsAutoplaced()

◆ GetFileName()

◆ GetFlags()

◆ GetFocusPosition()

◆ GetInstances()

◆ GetLayer()

◆ GetMenuImage()

◆ GetMinHeight()

◆ GetMinWidth()

◆ GetMsgPanelInfo()

◆ GetName()

◆ GetOrInitConnection()

◆ GetPageNumber()

◆ GetParent()

◆ GetPenWidth()

◆ GetPin()

◆ GetPins() [1/2]

◆ GetPins() [2/2]

◆ GetPosition()

◆ GetRotationCenter()

◆ GetScreen()