Class for a bus to bus entry. More...

#include <sch_bus_entry.h>

Inheritance diagram for SCH_BUS_BUS_ENTRY:

Public Member Functions
	SCH_BUS_BUS_ENTRY (const wxPoint &pos=wxPoint(0, 0), bool aFlipY=false)

	~SCH_BUS_BUS_ENTRY ()

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

int	GetPenWidth () const 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	CanConnect (const SCH_ITEM *aItem) const override

wxString	GetSelectMenuText (EDA_UNITS aUnits) 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...

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

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

bool	IsDanglingEnd () const

void	SetLastResolvedState (const SCH_ITEM *aItem) override

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

wxPoint	GetEnd () const

wxSize	GetSize () const

void	SetSize (const wxSize &aSize)

void	SetPenWidth (int aWidth)

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

virtual STROKE_PARAMS	GetStroke () const override

virtual void	SetStroke (const STROKE_PARAMS &aStroke) override

PLOT_DASH_TYPE	GetStrokeStyle () const

void	SetStrokeStyle (PLOT_DASH_TYPE aStyle)

COLOR4D	GetStrokeColor () const

void	SetStrokeColor (const COLOR4D &aColor)

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

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

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

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

void	Move (const wxPoint &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 wxPoint &aCenter) override
	Rotate the item around aCenter 90 degrees in the clockwise direction. More...

bool	IsDangling () const override

bool	IsConnectable () const override

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

wxPoint	GetPosition () const override

void	SetPosition (const wxPoint &aPosition) override

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

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

void	Plot (PLOTTER *aPlotter) const override
	Plot the schematic item to aPlotter. 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	operator< (const SCH_ITEM &aItem) const override

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

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

wxPoint &	GetStoredPos ()

void	SetStoredPos (const wxPoint &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	DoHypertextMenu (EDA_DRAW_FRAME *aFrame)

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

virtual bool	IsPointClickableAnchor (const wxPoint &aPos) const

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

bool	IsConnected (const wxPoint &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)

NETCLASSPTR	NetClass (const SCH_SHEET_PATH *aSheet=nullptr) const

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

void	SetFieldsAutoplaced ()

void	ClearFieldsAutoplaced ()

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

virtual void	AutoplaceFields (SCH_SCREEN *aScreen, bool aManual)

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

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

EDA_ITEM *	GetParent () const

virtual void	SetParent (EDA_ITEM *aParent)

bool	IsModified () const

bool	IsNew () const

bool	IsMoving () const

bool	IsDragging () const

bool	IsWireImage () const

bool	IsSelected () const

bool	IsEntered () const

bool	IsResized () const

bool	IsBrightened () const

void	SetWireImage ()

void	SetSelected ()

void	SetBrightened ()

void	ClearSelected ()

void	ClearBrightened ()

void	SetModified ()

int	GetState (EDA_ITEM_FLAGS type) const

void	SetState (EDA_ITEM_FLAGS type, bool state)

EDA_ITEM_FLAGS	GetStatus () const

void	SetStatus (EDA_ITEM_FLAGS aStatus)

void	SetFlags (EDA_ITEM_FLAGS aMask)

void	ClearFlags (EDA_ITEM_FLAGS aMask=EDA_ITEM_ALL_FLAGS)

EDA_ITEM_FLAGS	GetFlags () const

bool	HasFlag (EDA_ITEM_FLAGS aFlag) const

EDA_ITEM_FLAGS	GetEditFlags () const

void	ClearTempFlags ()

void	ClearEditFlags ()

virtual bool	IsType (const KICAD_T aScanTypes[]) const
	Check whether the item is one of the listed types. More...

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

bool	IsForceVisible () const

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

virtual SEARCH_RESULT	Visit (INSPECTOR inspector, void *testData, const KICAD_T scanTypes[])
	May be re-implemented for each derived class in order to handle all the types given by its member data. More...

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

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

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

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)

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

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

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

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

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

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

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

Public Attributes
SCH_ITEM *	m_connected_bus_items [2]
	Pointer to the bus items (usually bus wires) connected to this bus-bus entry (either or both may be nullptr) More...

const KIID	m_Uuid

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

Protected Attributes
wxPoint	m_pos

wxSize	m_size

bool	m_isDanglingStart

bool	m_isDanglingEnd

STROKE_PARAMS	m_stroke

PLOT_DASH_TYPE	m_lastResolvedLineStyle

int	m_lastResolvedWidth

COLOR4D	m_lastResolvedColor

SCH_LAYER_ID	m_layer

EDA_ITEMS	m_connections

FIELDS_AUTOPLACED	m_fieldsAutoplaced

wxPoint	m_storedPos

std::unordered_map< SCH_SHEET_PATH, SCH_ITEM_SET >	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

Detailed Description

Class for a bus to bus entry.

Definition at line 200 of file sch_bus_entry.h.

Constructor & Destructor Documentation

◆ SCH_BUS_BUS_ENTRY()

SCH_BUS_BUS_ENTRY::SCH_BUS_BUS_ENTRY	(	const wxPoint &	pos = `wxPoint( 0, 0 )`,
		bool	aFlipY = `false`
	)

Definition at line 100 of file sch_bus_entry.cpp.

  :
  SCH_BUS_ENTRY_BASE( SCH_BUS_BUS_ENTRY_T, pos, aFlipY )
 {
  m_layer = LAYER_BUS;
  m_connected_bus_items[0] = nullptr;
  m_connected_bus_items[1] = nullptr;
 
  m_lastResolvedWidth = Mils2iu( DEFAULT_WIRE_WIDTH_MILS );
  m_lastResolvedLineStyle = PLOT_DASH_TYPE::SOLID;
  m_lastResolvedColor = COLOR4D::UNSPECIFIED;
 }

References DEFAULT_WIRE_WIDTH_MILS, LAYER_BUS, m_connected_bus_items, SCH_BUS_ENTRY_BASE::m_lastResolvedColor, SCH_BUS_ENTRY_BASE::m_lastResolvedLineStyle, SCH_BUS_ENTRY_BASE::m_lastResolvedWidth, SCH_ITEM::m_layer, and SOLID.

Referenced by Clone().

◆ ~SCH_BUS_BUS_ENTRY()

SCH_BUS_BUS_ENTRY::~SCH_BUS_BUS_ENTRY ( )

inline

Definition at line 205 of file sch_bus_entry.h.

205 { }

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 183 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_TEXT::UpdateDanglingState(), and CONNECTION_GRAPH::updateItemConnectivity().

◆ 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 SCH_EDIT_TOOL::Mirror(), SCH_EDIT_TOOL::Properties(), SCH_EDIT_TOOL::Rotate(), SCH_SHEET::SCH_SHEET(), and SCH_EDIT_FRAME::SelectUnit().

◆ AutoplaceFields()

virtual void SCH_ITEM::AutoplaceFields	(	SCH_SCREEN *	aScreen,
		bool	aManual
	)

inlinevirtualinherited

Reimplemented in SCH_SYMBOL, SCH_GLOBALLABEL, and SCH_SHEET.

Definition at line 442 of file sch_item.h.

442 { }

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

◆ CanConnect()

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

inlineoverridevirtual

Reimplemented from SCH_ITEM.

Definition at line 221 of file sch_bus_entry.h.

  {
  return aItem->Type() == SCH_LINE_T && aItem->GetLayer() == LAYER_BUS;
  }

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

◆ ClassOf()

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

inlinestatic

Definition at line 207 of file sch_bus_entry.h.

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

References SCH_BUS_BUS_ENTRY_T, and EDA_ITEM::Type().

◆ ClearBrightened()

void EDA_ITEM::ClearBrightened ( )

inlineinherited

Definition at line 132 of file eda_item.h.

132 { ClearFlags( BRIGHTENED ); }

EDA_ITEM::ClearFlags

void ClearFlags(EDA_ITEM_FLAGS aMask=EDA_ITEM_ALL_FLAGS)

Definition: eda_item.h:153

BRIGHTENED

#define BRIGHTENED

item is drawn with a bright contour

Definition: eda_item_flags.h:65

References BRIGHTENED, and EDA_ITEM::ClearFlags().

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

◆ 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:488

References SCH_ITEM::m_connections.

◆ ClearEditFlags()

void EDA_ITEM::ClearEditFlags ( )

inlineinherited

Definition at line 171 of file eda_item.h.

  {
  ClearFlags( GetEditFlags() );
  }

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

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

◆ ClearFieldsAutoplaced()

void SCH_ITEM::ClearFieldsAutoplaced ( )

inlineinherited

Definition at line 427 of file sch_item.h.

427 { m_fieldsAutoplaced = FIELDS_AUTOPLACED_NO; }

SCH_ITEM::m_fieldsAutoplaced

FIELDS_AUTOPLACED m_fieldsAutoplaced

Definition: sch_item.h:489

FIELDS_AUTOPLACED_NO

Definition: sch_item.h:54

References FIELDS_AUTOPLACED_NO, and SCH_ITEM::m_fieldsAutoplaced.

Referenced by SCH_MOVE_TOOL::moveItem(), 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 153 of file eda_item.h.

153 { m_flags &= ~aMask; }

EDA_ITEM::m_flags

EDA_ITEM_FLAGS m_flags

Definition: eda_item.h:480

References EDA_ITEM::m_flags.

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

◆ ClearSelected()

void EDA_ITEM::ClearSelected ( )

inlineinherited

Definition at line 131 of file eda_item.h.

131 { ClearFlags( SELECTED ); }

EDA_ITEM::ClearFlags

void ClearFlags(EDA_ITEM_FLAGS aMask=EDA_ITEM_ALL_FLAGS)

Definition: eda_item.h:153

SELECTED

#define SELECTED

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

◆ ClearTempFlags()

void EDA_ITEM::ClearTempFlags ( )

inlineinherited

Definition at line 165 of file eda_item.h.

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

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

Referenced by SCH_EDIT_FRAME::PutDataInPreviousState().

◆ ClearViewPrivData()

void KIGFX::VIEW_ITEM::ClearViewPrivData ( )

inlineinherited

Definition at line 143 of file view_item.h.

  {
  m_viewPrivData = nullptr;
  }

References KIGFX::VIEW_ITEM::m_viewPrivData.

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

◆ Clone()

EDA_ITEM * SCH_BUS_BUS_ENTRY::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 119 of file sch_bus_entry.cpp.

 {
  return new SCH_BUS_BUS_ENTRY( *this );
 }

References SCH_BUS_BUS_ENTRY().

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

 {
  return m_connected_items[ aSheet ];
 }

References SCH_ITEM::m_connected_items.

Referenced by addConnections(), SCH_EDIT_FRAME::AddItemToScreenAndUndoList(), CONNECTION_GRAPH::updateItemConnectivity(), 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 138 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_PIN::GetMsgPanelInfo(), SCH_BUS_ENTRY_BASE::GetMsgPanelInfo(), SCH_LINE::GetMsgPanelInfo(), SCH_TEXT::GetMsgPanelInfo(), CONNECTION_SUBGRAPH::GetNetName(), SCH_ITEM::GetOrInitConnection(), highlightNet(), SCH_ITEM::InitializeConnection(), SCH_ITEM::NetClass(), SCH_TEXT::Plot(), SCH_GLOBALLABEL::Print(), SCH_HIERLABEL::Print(), SCH_EDIT_FRAME::RecalculateConnections(), CONNECTION_SUBGRAPH::ResolveDrivers(), 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_LINE, SCH_BUS_WIRE_ENTRY, and SCH_PIN.

Definition at line 411 of file sch_item.h.

411 { return true; }

Referenced by CONNECTION_GRAPH::updateItemConnectivity().

◆ DoHypertextMenu()

virtual void SCH_ITEM::DoHypertextMenu ( EDA_DRAW_FRAME * aFrame )

inlinevirtualinherited

Reimplemented in SCH_FIELD.

Definition at line 254 of file sch_item.h.

254 { }

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

◆ Get() [1/3]

wxAny INSPECTABLE::Get ( PROPERTY_BASE * aProperty )

inlineinherited

Definition at line 86 of file inspectable.h.

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

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

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

◆ Get() [2/3]

template<typename T >

T INSPECTABLE::Get ( PROPERTY_BASE * aProperty )

inlineinherited

Definition at line 95 of file inspectable.h.

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

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

◆ Get() [3/3]

template<typename T >

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

inlineinherited

Definition at line 104 of file inspectable.h.

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

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

◆ GetBoundingBox()

const EDA_RECT SCH_BUS_ENTRY_BASE::GetBoundingBox ( ) const

overridevirtualinherited

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 161 of file sch_bus_entry.cpp.

 {
  EDA_RECT box;
 
  box.SetOrigin( m_pos );
  box.SetEnd( GetEnd() );
 
  box.Normalize();
  box.Inflate( ( GetPenWidth() / 2 ) + 1 );
 
  return box;
 }

References SCH_BUS_ENTRY_BASE::GetEnd(), SCH_ITEM::GetPenWidth(), EDA_RECT::Inflate(), SCH_BUS_ENTRY_BASE::m_pos, EDA_RECT::Normalize(), EDA_RECT::SetEnd(), and EDA_RECT::SetOrigin().

Referenced by SCH_BUS_ENTRY_BASE::HitTest().

◆ GetClass()

wxString SCH_BUS_BUS_ENTRY::GetClass ( ) const

inlineoverridevirtual

Return the class name.

Reimplemented from SCH_ITEM.

Definition at line 212 of file sch_bus_entry.h.

  {
  return wxT( "SCH_BUS_BUS_ENTRY" );
  }

◆ GetConnectionPoints()

std::vector< wxPoint > SCH_BUS_ENTRY_BASE::GetConnectionPoints ( ) const

overridevirtualinherited

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 449 of file sch_bus_entry.cpp.

 {
  return { m_pos, GetEnd() };
 }

References SCH_BUS_ENTRY_BASE::GetEnd(), and SCH_BUS_ENTRY_BASE::m_pos.

◆ GetEditFlags()

EDA_ITEM_FLAGS EDA_ITEM::GetEditFlags ( ) const

inlineinherited

Definition at line 157 of file eda_item.h.

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

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

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

◆ GetEnd()

wxPoint SCH_BUS_ENTRY_BASE::GetEnd ( ) const

inherited

Definition at line 131 of file sch_bus_entry.cpp.

 {
  return wxPoint( m_pos.x + m_size.x, m_pos.y + m_size.y );
 }

References SCH_BUS_ENTRY_BASE::m_pos, and SCH_BUS_ENTRY_BASE::m_size.

Referenced by SCH_EDIT_FRAME::BreakSegmentsOnJunctions(), SCH_LINE_WIRE_BUS_TOOL::doDrawSegments(), SCH_BUS_ENTRY_BASE::doIsConnected(), SCH_LINE_WIRE_BUS_TOOL::doUnfoldBus(), KIGFX::SCH_PAINTER::draw(), SCH_BUS_ENTRY_BASE::GetBoundingBox(), SCH_BUS_ENTRY_BASE::GetConnectionPoints(), SCH_BUS_WIRE_ENTRY::GetEndPoints(), GetEndPoints(), SCH_BUS_ENTRY_BASE::HitTest(), SCH_EDIT_FRAME::OpenProjectFiles(), SCH_BUS_ENTRY_BASE::operator<(), SCH_BUS_ENTRY_BASE::Plot(), SCH_BUS_ENTRY_BASE::Print(), SCH_SEXPR_PLUGIN::saveBusEntry(), SCH_LEGACY_PLUGIN::saveBusEntry(), SCH_BUS_WIRE_ENTRY::UpdateDanglingState(), and UpdateDanglingState().

◆ GetEndPoints()

void SCH_BUS_BUS_ENTRY::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 257 of file sch_bus_entry.cpp.

 {
  DANGLING_END_ITEM item( BUS_ENTRY_END, this, m_pos );
  aItemList.push_back( item );
 
  DANGLING_END_ITEM item1( BUS_ENTRY_END, this, GetEnd() );
  aItemList.push_back( item1 );
 }

References BUS_ENTRY_END, SCH_BUS_ENTRY_BASE::GetEnd(), and SCH_BUS_ENTRY_BASE::m_pos.

◆ 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; }

SCH_ITEM::m_fieldsAutoplaced

FIELDS_AUTOPLACED m_fieldsAutoplaced

Definition: sch_item.h:489

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

◆ GetFlags()

EDA_ITEM_FLAGS EDA_ITEM::GetFlags ( ) const

inlineinherited

Definition at line 154 of file eda_item.h.

154 { return m_flags; }

EDA_ITEM::m_flags

EDA_ITEM_FLAGS m_flags

Definition: eda_item.h:480

References EDA_ITEM::m_flags.

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

◆ GetFocusPosition()

virtual const wxPoint EDA_ITEM::GetFocusPosition ( ) const

inlinevirtualinherited

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

Reimplemented in BOARD, PCB_TRACK, and PCB_SHAPE.

Definition at line 258 of file eda_item.h.

258 { return GetPosition(); }

EDA_ITEM::GetPosition

virtual wxPoint GetPosition() const

Definition: eda_item.h:251

References EDA_ITEM::GetPosition().

Referenced by SCH_EDIT_FRAME::FocusOnItem().

◆ GetLayer()

SCH_LAYER_ID SCH_ITEM::GetLayer ( ) const

inlineinherited

Return the layer this item is on.

Definition at line 259 of file sch_item.h.

259 { return m_layer; }

SCH_ITEM::m_layer

SCH_LAYER_ID m_layer

Definition: sch_item.h:487

References SCH_ITEM::m_layer.

Referenced by SCH_NO_CONNECT::CanConnect(), SCH_JUNCTION::CanConnect(), SCH_BUS_WIRE_ENTRY::CanConnect(), CanConnect(), SCH_LINE::CanConnect(), SCH_LABEL::CanConnect(), SCH_ITEM::CanConnect(), SCH_SHEET::CanConnect(), SCH_GLOBALLABEL::CanConnect(), SCH_HIERLABEL::CanConnect(), SCH_SYMBOL::CanConnect(), 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_TEXT::operator<(), SCH_LINE::operator<(), SCH_JUNCTION::Plot(), SCH_BITMAP::Plot(), SCH_FIELD::Plot(), SCH_LINE::Plot(), SCH_SCREEN::Plot(), SCH_JUNCTION::Print(), SCH_LINE::Print(), SCH_SCREEN::Print(), SCH_LEGACY_PLUGIN::saveBusEntry(), SCH_SEXPR_PLUGIN::saveLine(), SCH_LEGACY_PLUGIN::saveLine(), SCH_LEGACY_PLUGIN::saveText(), SCH_EDIT_FRAME::SchematicCleanUp(), SCH_EDIT_FRAME::TrimWire(), and CONNECTION_GRAPH::updateItemConnectivity().

◆ GetMenuImage()

BITMAPS SCH_BUS_BUS_ENTRY::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 473 of file sch_bus_entry.cpp.

 {
  return BITMAPS::add_bus2bus;
 }

References add_bus2bus.

◆ GetMsgPanelInfo()

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

overridevirtualinherited

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 520 of file sch_bus_entry.cpp.

 {
  wxString msg;
 
  switch( GetLayer() )
  {
  default:
  case LAYER_WIRE: msg = _( "Wire" ); break;
  case LAYER_BUS: msg = _( "Bus" ); break;
  }
 
  aList.emplace_back( _( "Bus Entry Type" ), msg );
 
  SCH_CONNECTION* conn = nullptr;
 
  if( !IsConnectivityDirty() && dynamic_cast<SCH_EDIT_FRAME*>( aFrame ) )
  conn = Connection();
 
  if( conn )
  {
  conn->AppendInfoToMsgPanel( aList );
 
  if( !conn->IsBus() )
  {
  NET_SETTINGS& netSettings = Schematic()->Prj().GetProjectFile().NetSettings();
  wxString netname = conn->Name();
  wxString netclassName = netSettings.m_NetClasses.GetDefaultPtr()->GetName();
 
  if( netSettings.m_NetClassAssignments.count( netname ) )
  netclassName = netSettings.m_NetClassAssignments[ netname ];
 
  aList.emplace_back( _( "Assigned Netclass" ), netclassName );
  }
  }
 }

References _, SCH_CONNECTION::AppendInfoToMsgPanel(), SCH_ITEM::Connection(), NETCLASSES::GetDefaultPtr(), SCH_ITEM::GetLayer(), NETCLASS::GetName(), PROJECT::GetProjectFile(), SCH_CONNECTION::IsBus(), SCH_ITEM::IsConnectivityDirty(), LAYER_BUS, LAYER_WIRE, NET_SETTINGS::m_NetClassAssignments, NET_SETTINGS::m_NetClasses, SCH_CONNECTION::Name(), PROJECT_FILE::NetSettings(), SCHEMATIC::Prj(), and SCH_ITEM::Schematic().

◆ GetOrInitConnection()

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

inherited

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

◆ GetParent()

EDA_ITEM* EDA_ITEM::GetParent ( void ) const

inlineinherited

Definition at line 114 of file eda_item.h.

114 { return m_parent; }

EDA_ITEM::m_parent

EDA_ITEM * m_parent

Linked list: Link (parent struct)

Definition: eda_item.h:478

References EDA_ITEM::m_parent.

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

◆ GetPenWidth()

int SCH_BUS_BUS_ENTRY::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 229 of file sch_bus_entry.cpp.

 {
  if( m_stroke.GetWidth() > 0 )
  {
  m_lastResolvedWidth = m_stroke.GetWidth();
  }
  else if( IsConnectable() && !IsConnectivityDirty() )
  {
  NETCLASSPTR netclass = NetClass();
 
  if( netclass )
  m_lastResolvedWidth = netclass->GetBusWidth();
  }
 
  return m_lastResolvedWidth;
 }

References STROKE_PARAMS::GetWidth(), SCH_BUS_ENTRY_BASE::IsConnectable(), SCH_ITEM::IsConnectivityDirty(), SCH_BUS_ENTRY_BASE::m_lastResolvedWidth, SCH_BUS_ENTRY_BASE::m_stroke, and SCH_ITEM::NetClass().

◆ GetPosition()

wxPoint SCH_BUS_ENTRY_BASE::GetPosition ( ) const

inlineoverridevirtualinherited

Reimplemented from EDA_ITEM.

Definition at line 113 of file sch_bus_entry.h.

113 { return m_pos; }

SCH_BUS_ENTRY_BASE::m_pos

wxPoint m_pos

Definition: sch_bus_entry.h:133

References SCH_BUS_ENTRY_BASE::m_pos.

Referenced by SCH_EDIT_FRAME::BreakSegmentsOnJunctions(), KIGFX::SCH_PAINTER::draw(), CONNECTION_GRAPH::ercCheckBusToBusEntryConflicts(), SCH_EDIT_FRAME::OpenProjectFiles(), SCH_BUS_ENTRY_BASE::operator<(), SCH_SEXPR_PLUGIN::saveBusEntry(), SCH_LEGACY_PLUGIN::saveBusEntry(), and SCH_DRAWING_TOOLS::SingleClickPlace().

◆ GetSelectMenuText()

wxString SCH_BUS_BUS_ENTRY::GetSelectMenuText ( EDA_UNITS aUnits ) 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 461 of file sch_bus_entry.cpp.

 {
  return wxString( _( "Bus to Bus Entry" ) );
 }

References _.

◆ GetSize()

wxSize SCH_BUS_ENTRY_BASE::GetSize ( ) const

inlineinherited

Definition at line 75 of file sch_bus_entry.h.

75 { return m_size; }

SCH_BUS_ENTRY_BASE::m_size

wxSize m_size

Definition: sch_bus_entry.h:134

References SCH_BUS_ENTRY_BASE::m_size.

Referenced by SCH_LINE_WIRE_BUS_TOOL::doDrawSegments(), and SCH_SEXPR_PLUGIN::saveBusEntry().

◆ GetState()

int EDA_ITEM::GetState ( EDA_ITEM_FLAGS type ) const

inlineinherited

Definition at line 136 of file eda_item.h.

  {
  return m_status & type;
  }

References EDA_ITEM::m_status.

Referenced by BOARD_ITEM::IsLocked().

◆ GetStatus()

EDA_ITEM_FLAGS EDA_ITEM::GetStatus ( ) const

inlineinherited

Definition at line 149 of file eda_item.h.

149 { return m_status; }

EDA_ITEM::m_status

EDA_ITEM_FLAGS m_status

Definition: eda_item.h:477

References EDA_ITEM::m_status.

◆ GetStoredPos()

wxPoint& SCH_ITEM::GetStoredPos ( )

inlineinherited

Definition at line 222 of file sch_item.h.

222 { return m_storedPos; }

SCH_ITEM::m_storedPos

wxPoint m_storedPos

Definition: sch_item.h:490

References SCH_ITEM::m_storedPos.

◆ GetStroke()

virtual STROKE_PARAMS SCH_BUS_ENTRY_BASE::GetStroke ( ) const

inlineoverridevirtualinherited

Reimplemented from SCH_ITEM.

Definition at line 81 of file sch_bus_entry.h.

81 { return m_stroke; }

SCH_BUS_ENTRY_BASE::m_stroke

STROKE_PARAMS m_stroke

Definition: sch_bus_entry.h:137

References SCH_BUS_ENTRY_BASE::m_stroke.

Referenced by KIGFX::SCH_PAINTER::draw(), and SCH_SEXPR_PLUGIN::saveBusEntry().

◆ GetStrokeColor()

COLOR4D SCH_BUS_ENTRY_BASE::GetStrokeColor ( ) const

inherited

Definition at line 175 of file sch_bus_entry.cpp.

 {
  if( m_stroke.GetColor() != COLOR4D::UNSPECIFIED )
  {
  m_lastResolvedColor = m_stroke.GetColor();
  }
  else if( IsConnectable() && !IsConnectivityDirty() )
  {
  NETCLASSPTR netclass = NetClass();
 
  if( netclass )
  m_lastResolvedColor = netclass->GetSchematicColor();
  }
 
  return m_lastResolvedColor;
 }

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

Referenced by SCH_BUS_ENTRY_BASE::Plot(), and SCH_BUS_ENTRY_BASE::Print().

◆ GetStrokeStyle()

PLOT_DASH_TYPE SCH_BUS_ENTRY_BASE::GetStrokeStyle ( ) const

inherited

Definition at line 193 of file sch_bus_entry.cpp.

 {
  if( m_stroke.GetPlotStyle() != PLOT_DASH_TYPE::DEFAULT )
  {
  m_lastResolvedLineStyle = m_stroke.GetPlotStyle();
  }
  else if( IsConnectable() && !IsConnectivityDirty() )
  {
  NETCLASSPTR netclass = NetClass();
 
  if( netclass )
  m_lastResolvedLineStyle = static_cast<PLOT_DASH_TYPE>( netclass->GetLineStyle() );
  }
 
  return m_lastResolvedLineStyle;
 }

References DEFAULT, STROKE_PARAMS::GetPlotStyle(), SCH_BUS_ENTRY_BASE::IsConnectable(), SCH_ITEM::IsConnectivityDirty(), SCH_BUS_ENTRY_BASE::m_lastResolvedLineStyle, SCH_BUS_ENTRY_BASE::m_stroke, and SCH_ITEM::NetClass().

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

◆ HasFlag()

bool EDA_ITEM::HasFlag ( EDA_ITEM_FLAGS aFlag ) const

inlineinherited

Definition at line 155 of file eda_item.h.

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

EDA_ITEM::m_flags

EDA_ITEM_FLAGS m_flags

Definition: eda_item.h:480

References EDA_ITEM::m_flags.

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

◆ HasLineStroke()

virtual bool SCH_BUS_ENTRY_BASE::HasLineStroke ( ) const

inlineoverridevirtualinherited

Check if this schematic item has line stoke properties.

See also: STROKE_PARAMS

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

Reimplemented from SCH_ITEM.

Definition at line 80 of file sch_bus_entry.h.

80 { return true; }

◆ HitTest() [1/2]

bool SCH_BUS_ENTRY_BASE::HitTest	(	const wxPoint &	aPosition,
		int	aAccuracy = `0`
	)		const

overridevirtualinherited

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

Parameters

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

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

Reimplemented from EDA_ITEM.

Definition at line 479 of file sch_bus_entry.cpp.

 {
  // Insure minimum accuracy
  if( aAccuracy == 0 )
  aAccuracy = ( GetPenWidth() / 2 ) + 4;
 
  return TestSegmentHit( aPosition, m_pos, GetEnd(), aAccuracy );
 }

References SCH_BUS_ENTRY_BASE::GetEnd(), SCH_ITEM::GetPenWidth(), SCH_BUS_ENTRY_BASE::m_pos, and TestSegmentHit().

◆ HitTest() [2/2]

bool SCH_BUS_ENTRY_BASE::HitTest	(	const EDA_RECT &	aRect,
		bool	aContained,
		int	aAccuracy = `0`
	)		const

overridevirtualinherited

Test if aRect intersects this item.

Parameters

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

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

Reimplemented from EDA_ITEM.

Definition at line 489 of file sch_bus_entry.cpp.

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

References EDA_RECT::Contains(), SCH_BUS_ENTRY_BASE::GetBoundingBox(), EDA_RECT::Inflate(), and EDA_RECT::Intersects().

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

125 { return m_flags & BRIGHTENED; }

EDA_ITEM::m_flags

EDA_ITEM_FLAGS m_flags

Definition: eda_item.h:480

BRIGHTENED

#define BRIGHTENED

item is drawn with a bright contour

Definition: eda_item_flags.h:65

References BRIGHTENED, and EDA_ITEM::m_flags.

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

◆ IsConnectable()

bool SCH_BUS_ENTRY_BASE::IsConnectable ( ) const

inlineoverridevirtualinherited

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

Reimplemented from SCH_ITEM.

Definition at line 109 of file sch_bus_entry.h.

109 { return true; }

Referenced by SCH_BUS_WIRE_ENTRY::GetPenWidth(), GetPenWidth(), SCH_BUS_ENTRY_BASE::GetStrokeColor(), and SCH_BUS_ENTRY_BASE::GetStrokeStyle().

◆ IsConnected()

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

inherited

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

Parameters

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

Returns: True if connection to aPoint exists.

Definition at line 129 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(), and SCH_SCREEN::IsTerminalPoint().

◆ 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:499

References SCH_ITEM::m_connectivity_dirty.

Referenced by SCH_ITEM::Connection(), KIGFX::SCH_PAINTER::draw(), SCH_LINE::GetEffectiveLineStyle(), SCH_JUNCTION::getEffectiveShape(), SCH_JUNCTION::GetJunctionColor(), SCH_LINE::GetLineColor(), SCH_PIN::GetMsgPanelInfo(), SCH_BUS_ENTRY_BASE::GetMsgPanelInfo(), SCH_LINE::GetMsgPanelInfo(), SCH_TEXT::GetMsgPanelInfo(), SCH_BUS_WIRE_ENTRY::GetPenWidth(), SCH_LINE::GetPenWidth(), GetPenWidth(), SCH_BUS_ENTRY_BASE::GetStrokeColor(), and SCH_BUS_ENTRY_BASE::GetStrokeStyle().

◆ IsDangling()

bool SCH_BUS_ENTRY_BASE::IsDangling ( ) const

overridevirtualinherited

Reimplemented from SCH_ITEM.

Definition at line 443 of file sch_bus_entry.cpp.

 {
  return m_isDanglingStart || m_isDanglingEnd;
 }

References SCH_BUS_ENTRY_BASE::m_isDanglingEnd, and SCH_BUS_ENTRY_BASE::m_isDanglingStart.

◆ IsDanglingEnd()

bool SCH_BUS_ENTRY_BASE::IsDanglingEnd ( ) const

inlineinherited

Definition at line 48 of file sch_bus_entry.h.

48 { return m_isDanglingEnd; }

SCH_BUS_ENTRY_BASE::m_isDanglingEnd

bool m_isDanglingEnd

Definition: sch_bus_entry.h:136

References SCH_BUS_ENTRY_BASE::m_isDanglingEnd.

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

◆ IsDanglingStart()

bool SCH_BUS_ENTRY_BASE::IsDanglingStart ( ) const

inlineinherited

Definition at line 47 of file sch_bus_entry.h.

47 { return m_isDanglingStart; }

SCH_BUS_ENTRY_BASE::m_isDanglingStart

bool m_isDanglingStart

Definition: sch_bus_entry.h:135

References SCH_BUS_ENTRY_BASE::m_isDanglingStart.

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

◆ IsDragging()

bool EDA_ITEM::IsDragging ( ) const

inlineinherited

Definition at line 120 of file eda_item.h.

120 { return m_flags & IS_DRAGGING; }

IS_DRAGGING

#define IS_DRAGGING

Item being dragged.

Definition: eda_item_flags.h:43

EDA_ITEM::m_flags

EDA_ITEM_FLAGS m_flags

Definition: eda_item.h:480

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

123 { return m_flags & ENTERED; }

EDA_ITEM::m_flags

EDA_ITEM_FLAGS m_flags

Definition: eda_item.h:480

ENTERED

#define ENTERED

indicates a group has been entered

Definition: eda_item_flags.h:72

References ENTERED, and EDA_ITEM::m_flags.

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

◆ IsForceVisible()

bool EDA_ITEM::IsForceVisible ( ) const

inlineinherited

Definition at line 205 of file eda_item.h.

205 { return m_forceVisible; }

EDA_ITEM::m_forceVisible

bool m_forceVisible

Definition: eda_item.h:479

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.

Definition at line 252 of file sch_item.h.

252 { return false; }

◆ IsLocked()

virtual bool SCH_ITEM::IsLocked ( ) const

inlinevirtualinherited

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

Definition at line 242 of file sch_item.h.

242 { return false; }

◆ IsModified()

bool EDA_ITEM::IsModified ( ) const

inlineinherited

Definition at line 117 of file eda_item.h.

117 { return m_flags & IS_CHANGED; }

IS_CHANGED

#define IS_CHANGED

Item was edited, and modified.

Definition: eda_item_flags.h:37

EDA_ITEM::m_flags

EDA_ITEM_FLAGS m_flags

Definition: eda_item.h:480

References IS_CHANGED, and EDA_ITEM::m_flags.

Referenced by PCB_EDIT_FRAME::OpenProjectFiles().

◆ IsMovableFromAnchorPoint()

bool SCH_BUS_ENTRY_BASE::IsMovableFromAnchorPoint ( ) const

inlineoverridevirtualinherited

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

Returns: false for a bus entry

Reimplemented from SCH_ITEM.

Definition at line 71 of file sch_bus_entry.h.

71 { return false; }

◆ IsMoving()

bool EDA_ITEM::IsMoving ( ) const

inlineinherited

Definition at line 119 of file eda_item.h.

119 { return m_flags & IS_MOVING; }

EDA_ITEM::m_flags

EDA_ITEM_FLAGS m_flags

Definition: eda_item.h:480

IS_MOVING

#define IS_MOVING

Item being moved.

Definition: eda_item_flags.h:40

References IS_MOVING, and EDA_ITEM::m_flags.

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

◆ IsNew()

bool EDA_ITEM::IsNew ( ) const

inlineinherited

Definition at line 118 of file eda_item.h.

118 { return m_flags & IS_NEW; }

IS_NEW

#define IS_NEW

New item, just created.

Definition: eda_item_flags.h:41

EDA_ITEM::m_flags

EDA_ITEM_FLAGS m_flags

Definition: eda_item.h:480

References IS_NEW, and EDA_ITEM::m_flags.

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

◆ IsPointClickableAnchor()

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

inlinevirtualinherited

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

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

Definition at line 355 of file sch_item.h.

355 { return false; }

◆ IsReplaceable()

virtual bool EDA_ITEM::IsReplaceable ( ) const

inlinevirtualinherited

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

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

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

Definition at line 402 of file eda_item.h.

402 { return false; }

Referenced by EDA_ITEM::Matches().

◆ IsResized()

bool EDA_ITEM::IsResized ( ) const

inlineinherited

Definition at line 124 of file eda_item.h.

124 { return m_flags & IS_RESIZING; }

IS_RESIZING

#define IS_RESIZING

Item being resized.

Definition: eda_item_flags.h:42

EDA_ITEM::m_flags

EDA_ITEM_FLAGS m_flags

Definition: eda_item.h:480

References IS_RESIZING, and EDA_ITEM::m_flags.

◆ IsSelected()

bool EDA_ITEM::IsSelected ( ) const

inlineinherited

Definition at line 122 of file eda_item.h.

122 { return m_flags & SELECTED; }

EDA_ITEM::m_flags

EDA_ITEM_FLAGS m_flags

Definition: eda_item.h:480

SELECTED

#define SELECTED

Definition: eda_item_flags.h:48

References EDA_ITEM::m_flags, and SELECTED.

◆ IsType()

virtual bool EDA_ITEM::IsType ( const KICAD_T aScanTypes[] ) const

inlinevirtualinherited

Check whether the item is one of the listed types.

Parameters

aScanTypes List of item types

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

Reimplemented in PCB_VIA, SCH_LABEL, PCB_DIMENSION_BASE, PAD, SCH_FIELD, FP_TEXT, SCH_LINE, PCB_SHAPE, FP_SHAPE, and PCB_TEXT.

Definition at line 182 of file eda_item.h.

  {
  if( aScanTypes[0] == SCH_LOCATE_ANY_T )
  return true;
 
  for( const KICAD_T* p = aScanTypes; *p != EOT; ++p )
  {
  if( m_structType == *p )
  return true;
  }
 
  return false;
  }

References EOT, EDA_ITEM::m_structType, and SCH_LOCATE_ANY_T.

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

◆ IsWireImage()

bool EDA_ITEM::IsWireImage ( ) const

inlineinherited

Definition at line 121 of file eda_item.h.

121 { return m_flags & IS_WIRE_IMAGE; }

EDA_ITEM::m_flags

EDA_ITEM_FLAGS m_flags

Definition: eda_item.h:480

IS_WIRE_IMAGE

#define IS_WIRE_IMAGE

Item to be drawn as wireframe while editing.

Definition: eda_item_flags.h:45

References IS_WIRE_IMAGE, and EDA_ITEM::m_flags.

◆ IterateForward() [1/2]

template<class T >

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

inlinestaticinherited

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

Definition at line 294 of file eda_item.h.

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

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

Referenced by GERBER_FILE_IMAGE::Visit().

◆ IterateForward() [2/2]

template<class T >

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

inlinestaticinherited

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

Definition at line 313 of file eda_item.h.

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

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

◆ Matches() [1/2]

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

inlinevirtualinherited

Compare the item against the search criteria in aSearchData.

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

Parameters

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

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

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

Definition at line 364 of file eda_item.h.

  {
  return false;
  }

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

◆ Matches() [2/2]

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

protectedinherited

Compare aText against search criteria in aSearchData.

This is a helper function for simplify derived class logic.

Parameters

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

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

Definition at line 118 of file eda_item.cpp.

 {
  wxString text = aText;
  int flags = aSearchData.GetFlags();
  wxString searchText = aSearchData.GetFindString();
 
  // Don't match if searching for replaceable item and the item doesn't support text replace.
  if( ( flags & FR_SEARCH_REPLACE ) && !IsReplaceable() )
  return false;
 
  if( !( flags & wxFR_MATCHCASE ) )
  {
  text.MakeUpper();
  searchText.MakeUpper();
  }
 
  if( flags & wxFR_WHOLEWORD )
  {
  int ii = 0;
 
  while( ii < (int) text.length() )
  {
  int next = text.find( searchText, ii );
 
  if( next == wxNOT_FOUND )
  return false;
 
  ii = next;
  next += searchText.length();
 
  bool startOK = ( ii == 0 || !wxIsalnum( text.GetChar( ii - 1 ) ) );
  bool endOK = ( next == (int) text.length() || !wxIsalnum( text.GetChar( next ) ) );
 
  if( startOK && endOK )
  return true;
  else
  ii++;
  }
 
  return false;
  }
  else if( flags & FR_MATCH_WILDCARD )
  {
  return text.Matches( searchText );
  }
  else
  {
  return text.Find( searchText ) != wxNOT_FOUND;
  }
 }

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

◆ MirrorHorizontally()

void SCH_BUS_ENTRY_BASE::MirrorHorizontally ( int aCenter )

overridevirtualinherited

Mirror item horizontally about aCenter.

Implements SCH_ITEM.

Definition at line 332 of file sch_bus_entry.cpp.

 {
  MIRROR( m_pos.x, aCenter );
  m_size.x = -m_size.x;
 }

References SCH_BUS_ENTRY_BASE::m_pos, SCH_BUS_ENTRY_BASE::m_size, and MIRROR().

Referenced by SCH_DRAWING_TOOLS::SingleClickPlace().

◆ MirrorVertically()

void SCH_BUS_ENTRY_BASE::MirrorVertically ( int aCenter )

overridevirtualinherited

Mirror item vertically about aCenter.

Implements SCH_ITEM.

Definition at line 325 of file sch_bus_entry.cpp.

 {
  MIRROR( m_pos.y, aCenter );
  m_size.y = -m_size.y;
 }

References SCH_BUS_ENTRY_BASE::m_pos, SCH_BUS_ENTRY_BASE::m_size, and MIRROR().

Referenced by SCH_DRAWING_TOOLS::SingleClickPlace().

◆ Move()

void SCH_BUS_ENTRY_BASE::Move ( const wxPoint & aMoveVector )

inlineoverridevirtualinherited

Move the item by aMoveVector to a new position.

Implements SCH_ITEM.

Definition at line 98 of file sch_bus_entry.h.

  {
  m_pos += aMoveVector;
  }

References SCH_BUS_ENTRY_BASE::m_pos.

◆ NetClass()

NETCLASSPTR SCH_ITEM::NetClass ( const SCH_SHEET_PATH * aSheet = nullptr ) const

inherited

Definition at line 158 of file sch_item.cpp.

 {
  if( m_connection_map.size() )
  {
  SCH_CONNECTION* connection = Connection( aSheet );
 
  if( connection )
  {
  NET_SETTINGS& netSettings = Schematic()->Prj().GetProjectFile().NetSettings();
  const wxString& netclassName = netSettings.GetNetclassName( connection->Name() );
 
  return netSettings.m_NetClasses.Find( netclassName );
  }
  }
 
  return nullptr;
 }

References SCH_ITEM::Connection(), NETCLASSES::Find(), NET_SETTINGS::GetNetclassName(), PROJECT::GetProjectFile(), SCH_ITEM::m_connection_map, NET_SETTINGS::m_NetClasses, SCH_CONNECTION::Name(), PROJECT_FILE::NetSettings(), SCHEMATIC::Prj(), and SCH_ITEM::Schematic().

Referenced by SCH_LINE::GetEffectiveLineStyle(), SCH_JUNCTION::getEffectiveShape(), SCH_JUNCTION::GetJunctionColor(), SCH_LINE::GetLineColor(), SCH_BUS_WIRE_ENTRY::GetPenWidth(), SCH_LINE::GetPenWidth(), GetPenWidth(), SCH_BUS_ENTRY_BASE::GetStrokeColor(), and SCH_BUS_ENTRY_BASE::GetStrokeStyle().

◆ operator<() [1/2]

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

overridevirtualinherited

Reimplemented from SCH_ITEM.

Definition at line 558 of file sch_bus_entry.cpp.

 {
  if( Type() != aItem.Type() )
  return Type() < aItem.Type();
 
  auto symbol = static_cast<const SCH_BUS_ENTRY_BASE*>( &aItem );
 
  if( GetLayer() != symbol->GetLayer() )
  return GetLayer() < symbol->GetLayer();
 
  if( GetPosition().x != symbol->GetPosition().x )
  return GetPosition().x < symbol->GetPosition().x;
 
  if( GetPosition().y != symbol->GetPosition().y )
  return GetPosition().y < symbol->GetPosition().y;
 
  if( GetEnd().x != symbol->GetEnd().x )
  return GetEnd().x < symbol->GetEnd().x;
 
  return GetEnd().y < symbol->GetEnd().y;
 }

References SCH_BUS_ENTRY_BASE::GetEnd(), SCH_ITEM::GetLayer(), SCH_BUS_ENTRY_BASE::GetPosition(), and EDA_ITEM::Type().

◆ operator<() [2/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 234 of file eda_item.cpp.

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

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

◆ Plot()

void SCH_BUS_ENTRY_BASE::Plot ( PLOTTER * aPlotter ) const

overridevirtualinherited

Plot the schematic item to aPlotter.

Parameters

aPlotter is the PLOTTER object to plot to.

Reimplemented from SCH_ITEM.

Definition at line 502 of file sch_bus_entry.cpp.

 {
  auto* settings = static_cast<KIGFX::SCH_RENDER_SETTINGS*>( aPlotter->RenderSettings() );
 
  COLOR4D color = ( GetStrokeColor() == COLOR4D::UNSPECIFIED ) ?
  settings->GetLayerColor( m_layer ) : GetStrokeColor();
  int penWidth = ( GetPenWidth() == 0 ) ? settings->GetDefaultPenWidth() : GetPenWidth();
 
  penWidth = std::max( penWidth, settings->GetMinPenWidth() );
 
  aPlotter->SetCurrentLineWidth( penWidth );
  aPlotter->SetColor( color );
  aPlotter->SetDash( GetStrokeStyle() );
  aPlotter->MoveTo( m_pos );
  aPlotter->FinishTo( GetEnd() );
 }

References color, PLOTTER::FinishTo(), SCH_BUS_ENTRY_BASE::GetEnd(), SCH_ITEM::GetPenWidth(), SCH_BUS_ENTRY_BASE::GetStrokeColor(), SCH_BUS_ENTRY_BASE::GetStrokeStyle(), SCH_ITEM::m_layer, SCH_BUS_ENTRY_BASE::m_pos, PLOTTER::MoveTo(), PLOTTER::RenderSettings(), PLOTTER::SetColor(), PLOTTER::SetCurrentLineWidth(), and PLOTTER::SetDash().

◆ Print()

void SCH_BUS_ENTRY_BASE::Print	(	const RENDER_SETTINGS *	aSettings,
		const wxPoint &	aOffset
	)

overridevirtualinherited

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 267 of file sch_bus_entry.cpp.

 {
  wxDC* DC = aSettings->GetPrintDC();
  COLOR4D color = ( GetStrokeColor() == COLOR4D::UNSPECIFIED ) ?
  aSettings->GetLayerColor( m_layer ) : GetStrokeColor();
  wxPoint start = m_pos + aOffset;
  wxPoint end = GetEnd() + aOffset;
  int penWidth = ( GetPenWidth() == 0 ) ? aSettings->GetDefaultPenWidth() : GetPenWidth();
 
  if( GetStrokeStyle() <= PLOT_DASH_TYPE::FIRST_TYPE )
  {
  GRLine( nullptr, DC, start.x, start.y, end.x, end.y, penWidth, color );
  }
  else
  {
  EDA_RECT clip( (wxPoint) start, wxSize( end.x - start.x, end.y - start.y ) );
  clip.Normalize();
 
  double theta = atan2( end.y - start.y, end.x - start.x );
  double strokes[] = { 1.0, dash_gap_len( penWidth ), 1.0, dash_gap_len( penWidth ) };
 
  switch( GetStrokeStyle() )
  {
  default:
  case PLOT_DASH_TYPE::DASH:
  strokes[0] = strokes[2] = dash_mark_len( penWidth );
  break;
  case PLOT_DASH_TYPE::DOT:
  strokes[0] = strokes[2] = dot_mark_len( penWidth );
  break;
  case PLOT_DASH_TYPE::DASHDOT:
  strokes[0] = dash_mark_len( penWidth );
  strokes[2] = dot_mark_len( penWidth );
  break;
  }
 
  for( size_t i = 0; i < 10000; ++i )
  {
  // Calculations MUST be done in doubles to keep from accumulating rounding
  // errors as we go.
  wxPoint next( start.x + strokes[ i % 4 ] * cos( theta ),
  start.y + strokes[ i % 4 ] * sin( theta ) );
 
  // Drawing each segment can be done rounded to ints.
  wxPoint segStart( KiROUND( start.x ), KiROUND( start.y ) );
  wxPoint segEnd( KiROUND( next.x ), KiROUND( next.y ) );
 
  if( ClipLine( &clip, segStart.x, segStart.y, segEnd.x, segEnd.y ) )
  break;
  else if( i % 2 == 0 )
  GRLine( nullptr, DC, segStart.x, segStart.y, segEnd.x, segEnd.y, penWidth, color );
 
  start = next;
  }
  }
 }

References ClipLine(), color, DASH, dash_gap_len(), dash_mark_len(), DASHDOT, DOT, dot_mark_len(), FIRST_TYPE, KIGFX::RENDER_SETTINGS::GetDefaultPenWidth(), SCH_BUS_ENTRY_BASE::GetEnd(), KIGFX::RENDER_SETTINGS::GetLayerColor(), SCH_ITEM::GetPenWidth(), KIGFX::RENDER_SETTINGS::GetPrintDC(), SCH_BUS_ENTRY_BASE::GetStrokeColor(), SCH_BUS_ENTRY_BASE::GetStrokeStyle(), GRLine(), KiROUND(), SCH_ITEM::m_layer, SCH_BUS_ENTRY_BASE::m_pos, next(), and EDA_RECT::Normalize().

◆ Replace() [1/2]

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

staticinherited

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

Parameters

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

Returns: True if aText was modified, otherwise false.

Definition at line 170 of file eda_item.cpp.

 {
  wxString text = aText;
  int flags = aSearchData.GetFlags();
  wxString searchText = aSearchData.GetFindString();
  wxString result;
  bool replaced = false;
 
  if( flags & wxFR_MATCHCASE )
  {
  text = text.Upper();
  searchText = searchText.Upper();
  }
 
  int ii = 0;
 
  while( ii < (int) text.length() )
  {
  int next = text.find( searchText, ii );
 
  if( next == wxNOT_FOUND )
  {
  result += aText.Mid( ii, wxString::npos );
  break;
  }
 
  if( next > ii )
  result += aText.Mid( ii, next - ii );
 
  ii = next;
  next += searchText.length();
 
  bool startOK;
  bool endOK;
 
  if( flags & wxFR_WHOLEWORD )
  {
  startOK = ( ii == 0 || !wxIsalnum( text.GetChar( ii - 1 ) ) );
  endOK = ( next == (int) text.length() || !wxIsalnum( text.GetChar( next ) ) );
  }
  else
  {
  startOK = true;
  endOK = true;
  }
 
  if( startOK && endOK )
  {
  result += aSearchData.GetReplaceString();
  replaced = true;
  ii = next;
  }
  else
  {
  result += aText.GetChar( ii );
  ii++;
  }
  }
 
  aText = result;
  return replaced;
 }

References next(), and text.

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

◆ Replace() [2/2]

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

inlinevirtualinherited

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

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

Parameters

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

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

Reimplemented in SCH_TEXT, SCH_FIELD, SCH_SHEET_PIN, and SCH_PIN.

Definition at line 391 of file eda_item.h.

  {
  return false;
  }

◆ Rotate()

void SCH_BUS_ENTRY_BASE::Rotate ( const wxPoint & aCenter )

overridevirtualinherited

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

Implements SCH_ITEM.

Definition at line 339 of file sch_bus_entry.cpp.

 {
  RotatePoint( &m_pos, aCenter, 900 );
  RotatePoint( &m_size.x, &m_size.y, 900 );
 }

References SCH_BUS_ENTRY_BASE::m_pos, SCH_BUS_ENTRY_BASE::m_size, and RotatePoint().

Referenced by SCH_DRAWING_TOOLS::SingleClickPlace().

◆ RunOnChildren()

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

inlinevirtualinherited

Reimplemented in SCH_SYMBOL, SCH_SHEET, and SCH_GLOBALLABEL.

Definition at line 444 of file sch_item.h.

444 { }

Referenced by SCH_ITEM::Duplicate(), SCH_SHEET_LIST::GetItem(), and SCH_DRAWING_TOOLS::TwoClickPlace().

◆ Schematic()

SCHEMATIC * SCH_ITEM::Schematic ( ) const

inherited

Searches the item hierarchy to find a SCHEMATIC.

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

Every SCH_SCREEN should be parented to the SCHEMATIC.

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

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

Definition at line 104 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_ITEM::Connection(), SCH_DRAWING_TOOLS::createSheetPin(), DIALOG_SCH_FIELD_PROPERTIES::DIALOG_SCH_FIELD_PROPERTIES(), SCH_FIELD::DoHypertextMenu(), SCH_GLOBALLABEL::GetBoundingBox(), SCH_MARKER::GetColorLayer(), SCH_JUNCTION::getEffectiveShape(), SCH_TEXT::GetLabelBoxExpansion(), SCH_BUS_ENTRY_BASE::GetMsgPanelInfo(), SCH_LINE::GetMsgPanelInfo(), SCH_TEXT::GetMsgPanelInfo(), SCH_NO_CONNECT::GetPenWidth(), SCH_SHEET_PIN::GetPenWidth(), SCH_LINE::GetPenWidth(), SCH_SHEET::GetPenWidth(), SCH_SYMBOL::GetPins(), SCH_FIELD::GetShownText(), SCH_TEXT::GetShownText(), SCH_TEXT::GetTextOffset(), SCH_PIN::HitTest(), SCH_GLOBALLABEL::HitTest(), inheritNetclass(), SCH_SHEET::IsRootSheet(), SCH_LABEL::IsType(), SCH_ITEM::NetClass(), DIALOG_SYMBOL_PROPERTIES::OnAddField(), DIALOG_TEXT_AND_LABEL_PROPERTIES::onScintillaCharAdded(), DIALOG_SCH_FIELD_PROPERTIES::onScintillaCharAdded(), SCH_GLOBALLABEL::Plot(), SCH_GLOBALLABEL::Print(), SCH_HIERLABEL::Print(), SCH_SHEET::ResolveTextVar(), SCH_SYMBOL::ResolveTextVar(), SCH_GLOBALLABEL::ResolveTextVar(), DIALOG_SCH_FIELD_PROPERTIES::UpdateField(), and SCH_MARKER::ViewGetLayers().

◆ Set() [1/3]

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

inlineinherited

Definition at line 42 of file inspectable.h.

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

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

◆ Set() [2/3]

template<typename T >

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

inlineinherited

Definition at line 55 of file inspectable.h.

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

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

◆ Set() [3/3]

template<typename T >

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

inlineinherited

Definition at line 68 of file inspectable.h.

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

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

◆ SetBrightened()

void EDA_ITEM::SetBrightened ( )

inlineinherited

Definition at line 129 of file eda_item.h.

129 { SetFlags( BRIGHTENED ); }

EDA_ITEM::SetFlags

void SetFlags(EDA_ITEM_FLAGS aMask)

Definition: eda_item.h:152

BRIGHTENED

#define BRIGHTENED

item is drawn with a bright contour

Definition: eda_item_flags.h:65

References BRIGHTENED, and EDA_ITEM::SetFlags().

Referenced by GERBVIEW_SELECTION_TOOL::disambiguationMenu(), KIGFX::SCH_PAINTER::draw(), SCH_EDIT_FRAME::FocusOnItem(), PCB_BASE_FRAME::FocusOnItems(), PL_SELECTION_TOOL::highlight(), EE_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; }

SCH_ITEM::m_connectivity_dirty

bool m_connectivity_dirty

Definition: sch_item.h:499

References SCH_ITEM::m_connectivity_dirty.

Referenced by SCH_EDIT_FRAME::BreakSegment(), SCH_ITEM::GetOrInitConnection(), SCH_ITEM::InitializeConnection(), SCH_LINE::MergeOverlap(), SCH_EDITOR_CONTROL::Paste(), and SCH_EDIT_FRAME::SaveCopyInUndoList().

◆ SetFieldsAutoplaced()

void SCH_ITEM::SetFieldsAutoplaced ( )

inlineinherited

Definition at line 426 of file sch_item.h.

426 { m_fieldsAutoplaced = FIELDS_AUTOPLACED_AUTO; }

FIELDS_AUTOPLACED_AUTO

Definition: sch_item.h:55

SCH_ITEM::m_fieldsAutoplaced

FIELDS_AUTOPLACED m_fieldsAutoplaced

Definition: sch_item.h:489

References FIELDS_AUTOPLACED_AUTO, and SCH_ITEM::m_fieldsAutoplaced.

◆ SetFlags()

void EDA_ITEM::SetFlags ( EDA_ITEM_FLAGS aMask )

inlineinherited

Definition at line 152 of file eda_item.h.

152 { m_flags |= aMask; }

EDA_ITEM::m_flags

EDA_ITEM_FLAGS m_flags

Definition: eda_item.h:480

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

203 { m_forceVisible = aEnable; }

EDA_ITEM::m_forceVisible

bool m_forceVisible

Definition: eda_item.h:479

References EDA_ITEM::m_forceVisible.

Referenced by SCH_EDITOR_CONTROL::UpdateFind().

◆ SetLastResolvedState()

void SCH_BUS_ENTRY_BASE::SetLastResolvedState ( const SCH_ITEM * aItem )

inlineoverridevirtualinherited

Reimplemented from SCH_ITEM.

Definition at line 54 of file sch_bus_entry.h.

  {
  const SCH_BUS_ENTRY_BASE* aEntry = dynamic_cast<const SCH_BUS_ENTRY_BASE*>( aItem );
 
  if( aEntry )
  {
  m_lastResolvedWidth = aEntry->m_lastResolvedWidth;
  m_lastResolvedLineStyle = aEntry->m_lastResolvedLineStyle;
  m_lastResolvedColor = aEntry->m_lastResolvedColor;
  }
  }

References SCH_BUS_ENTRY_BASE::m_lastResolvedColor, SCH_BUS_ENTRY_BASE::m_lastResolvedLineStyle, and SCH_BUS_ENTRY_BASE::m_lastResolvedWidth.

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

266 { m_layer = aLayer; }

SCH_ITEM::m_layer

SCH_LAYER_ID m_layer

Definition: sch_item.h:487

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_FIELD::SetId(), and CONNECTION_GRAPH::updateItemConnectivity().

◆ SetLocked()

virtual void SCH_ITEM::SetLocked ( bool aLocked )

inlinevirtualinherited

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

Definition at line 247 of file sch_item.h.

247 {}

◆ SetModified()

void EDA_ITEM::SetModified ( )

inherited

Definition at line 65 of file eda_item.cpp.

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

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

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

◆ SetParent()

virtual void EDA_ITEM::SetParent ( EDA_ITEM * aParent )

inlinevirtualinherited

Reimplemented in PCB_DIMENSION_BASE.

Definition at line 115 of file eda_item.h.

115 { m_parent = aParent; }

EDA_ITEM::m_parent

EDA_ITEM * m_parent

Linked list: Link (parent struct)

Definition: eda_item.h:478

References EDA_ITEM::m_parent.

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

◆ SetPenWidth()

void SCH_BUS_ENTRY_BASE::SetPenWidth ( int aWidth )

inlineinherited

Definition at line 78 of file sch_bus_entry.h.

78 { m_stroke.SetWidth( aWidth ); }

STROKE_PARAMS::SetWidth

void SetWidth(int aWidth)

Definition: sch_item.h:153

SCH_BUS_ENTRY_BASE::m_stroke

STROKE_PARAMS m_stroke

Definition: sch_bus_entry.h:137

References SCH_BUS_ENTRY_BASE::m_stroke, and STROKE_PARAMS::SetWidth().

◆ SetPosition()

void SCH_BUS_ENTRY_BASE::SetPosition ( const wxPoint & aPosition )

inlineoverridevirtualinherited

Reimplemented from EDA_ITEM.

Definition at line 114 of file sch_bus_entry.h.

114 { m_pos = aPosition; }

SCH_BUS_ENTRY_BASE::m_pos

wxPoint m_pos

Definition: sch_bus_entry.h:133

References SCH_BUS_ENTRY_BASE::m_pos.

Referenced by PANEL_EESCHEMA_COLOR_SETTINGS::createPreviewItems().

◆ SetSelected()

void EDA_ITEM::SetSelected ( )

inlineinherited

Definition at line 128 of file eda_item.h.

128 { SetFlags( SELECTED ); }

EDA_ITEM::SetFlags

void SetFlags(EDA_ITEM_FLAGS aMask)

Definition: eda_item.h:152

SELECTED

#define SELECTED

Definition: eda_item_flags.h:48

References SELECTED, and EDA_ITEM::SetFlags().

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

◆ SetSize()

void SCH_BUS_ENTRY_BASE::SetSize ( const wxSize & aSize )

inlineinherited

Definition at line 76 of file sch_bus_entry.h.

76 { m_size = aSize; }

SCH_BUS_ENTRY_BASE::m_size

wxSize m_size

Definition: sch_bus_entry.h:134

References SCH_BUS_ENTRY_BASE::m_size.

Referenced by SCH_LINE_WIRE_BUS_TOOL::doDrawSegments(), CADSTAR_SCH_ARCHIVE_LOADER::loadNets(), and SCH_ALTIUM_PLUGIN::ParseBusEntry().

◆ SetState()

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

inlineinherited

Definition at line 141 of file eda_item.h.

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

References EDA_ITEM::m_status.

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

◆ SetStatus()

void EDA_ITEM::SetStatus ( EDA_ITEM_FLAGS aStatus )

inlineinherited

Definition at line 150 of file eda_item.h.

150 { m_status = aStatus; }

EDA_ITEM::m_status

EDA_ITEM_FLAGS m_status

Definition: eda_item.h:477

References EDA_ITEM::m_status.

Referenced by BOARD_NETLIST_UPDATER::UpdateNetlist().

◆ SetStoredPos()

void SCH_ITEM::SetStoredPos ( const wxPoint & aPos )

inlineinherited

Definition at line 223 of file sch_item.h.

223 { m_storedPos = aPos; }

SCH_ITEM::m_storedPos

wxPoint m_storedPos

Definition: sch_item.h:490

References SCH_ITEM::m_storedPos.

Referenced by SCH_MOVE_TOOL::Main().

◆ SetStroke()

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

inlineoverridevirtualinherited

Reimplemented from SCH_ITEM.

Definition at line 82 of file sch_bus_entry.h.

82 { m_stroke = aStroke; }

SCH_BUS_ENTRY_BASE::m_stroke

STROKE_PARAMS m_stroke

Definition: sch_bus_entry.h:137

References SCH_BUS_ENTRY_BASE::m_stroke.

◆ SetStrokeColor()

void SCH_BUS_ENTRY_BASE::SetStrokeColor ( const COLOR4D & aColor )

inlineinherited

Definition at line 88 of file sch_bus_entry.h.

88 { m_stroke.SetColor( aColor ); }

SCH_BUS_ENTRY_BASE::m_stroke

STROKE_PARAMS m_stroke

Definition: sch_bus_entry.h:137

STROKE_PARAMS::SetColor

void SetColor(const COLOR4D &aColor)

Definition: sch_item.h:159

References SCH_BUS_ENTRY_BASE::m_stroke, and STROKE_PARAMS::SetColor().

◆ SetStrokeStyle()

void SCH_BUS_ENTRY_BASE::SetStrokeStyle ( PLOT_DASH_TYPE aStyle )

inlineinherited

Definition at line 85 of file sch_bus_entry.h.

85 { m_stroke.SetPlotStyle( aStyle ); }

STROKE_PARAMS::SetPlotStyle

void SetPlotStyle(PLOT_DASH_TYPE aPlotStyle)

Definition: sch_item.h:156

SCH_BUS_ENTRY_BASE::m_stroke

STROKE_PARAMS m_stroke

Definition: sch_bus_entry.h:137

References SCH_BUS_ENTRY_BASE::m_stroke, and STROKE_PARAMS::SetPlotStyle().

◆ SetWireImage()

void EDA_ITEM::SetWireImage ( )

inlineinherited

Definition at line 127 of file eda_item.h.

127 { SetFlags( IS_WIRE_IMAGE ); }

EDA_ITEM::SetFlags

void SetFlags(EDA_ITEM_FLAGS aMask)

Definition: eda_item.h:152

IS_WIRE_IMAGE

#define IS_WIRE_IMAGE

Item to be drawn as wireframe while editing.

Definition: eda_item_flags.h:45

References IS_WIRE_IMAGE, and EDA_ITEM::SetFlags().

◆ Sort()

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

inlinestaticinherited

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

Parameters

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

Returns: True if aLeft is less than aRight.

Definition at line 420 of file eda_item.h.

420 { return *aLeft < *aRight; }

◆ SwapData()

void SCH_BUS_ENTRY_BASE::SwapData ( SCH_ITEM * aItem )

overridevirtualinherited

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 137 of file sch_bus_entry.cpp.

 {
  SCH_BUS_ENTRY_BASE* item = dynamic_cast<SCH_BUS_ENTRY_BASE*>( aItem );
  wxCHECK_RET( item, wxT( "Cannot swap bus entry data with invalid item." ) );
 
  std::swap( m_pos, item->m_pos );
  std::swap( m_size, item->m_size );
  std::swap( m_stroke, item->m_stroke );
 
  std::swap( m_lastResolvedWidth, item->m_lastResolvedWidth );
  std::swap( m_lastResolvedLineStyle, item->m_lastResolvedLineStyle );
  std::swap( m_lastResolvedColor, item->m_lastResolvedColor );
 }

References SCH_BUS_ENTRY_BASE::m_lastResolvedColor, SCH_BUS_ENTRY_BASE::m_lastResolvedLineStyle, SCH_BUS_ENTRY_BASE::m_lastResolvedWidth, SCH_BUS_ENTRY_BASE::m_pos, SCH_BUS_ENTRY_BASE::m_size, and SCH_BUS_ENTRY_BASE::m_stroke.

◆ Type()

KICAD_T EDA_ITEM::Type ( ) const

inlineinherited

Returns the type of object.

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

Returns: the type of object.

Definition at line 112 of file eda_item.h.

112 { 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:487

References EDA_ITEM::m_structType.

◆ UpdateDanglingState()

bool SCH_BUS_BUS_ENTRY::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 405 of file sch_bus_entry.cpp.

 {
  bool previousStateStart = m_isDanglingStart;
  bool previousStateEnd = m_isDanglingEnd;
 
  m_isDanglingStart = m_isDanglingEnd = true;
 
  for( unsigned ii = 0; ii < aItemList.size(); ii++ )
  {
  DANGLING_END_ITEM& item = aItemList[ii];
 
  if( item.GetItem() == this )
  continue;
 
  switch( item.GetType() )
  {
  case BUS_END:
  {
  // The bus has created 2 DANGLING_END_ITEMs, one per end.
  DANGLING_END_ITEM& nextItem = aItemList[++ii];
 
  if( IsPointOnSegment( item.GetPosition(), nextItem.GetPosition(), m_pos ) )
  m_isDanglingStart = false;
  if( IsPointOnSegment( item.GetPosition(), nextItem.GetPosition(), GetEnd() ) )
  m_isDanglingEnd = false;
  }
  break;
 
  default:
  break;
  }
  }
 
  return (previousStateStart != m_isDanglingStart) || (previousStateEnd != m_isDanglingEnd);
 }

References BUS_END, SCH_BUS_ENTRY_BASE::GetEnd(), DANGLING_END_ITEM::GetItem(), DANGLING_END_ITEM::GetPosition(), DANGLING_END_ITEM::GetType(), IsPointOnSegment(), SCH_BUS_ENTRY_BASE::m_isDanglingEnd, SCH_BUS_ENTRY_BASE::m_isDanglingStart, and SCH_BUS_ENTRY_BASE::m_pos.

◆ ViewBBox()

const BOX2I EDA_ITEM::ViewBBox ( ) const

overridevirtualinherited

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

Returns: the current bounding box.

Implements KIGFX::VIEW_ITEM.

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

Definition at line 257 of file eda_item.cpp.

 {
  // Basic fallback
  EDA_RECT bbox = GetBoundingBox();
 
  return BOX2I( bbox.GetOrigin(), bbox.GetSize() );
 }

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

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

◆ ViewDraw()

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

inlinevirtualinherited

Draw the parts of the object belonging to layer aLayer.

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

Parameters

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

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

Definition at line 106 of file view_item.h.

107 {}

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

◆ ViewGetLayers()

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

overridevirtualinherited

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

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

Parameters

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

Reimplemented from EDA_ITEM.

Definition at line 152 of file sch_bus_entry.cpp.

 {
  aCount = 3;
  aLayers[0] = LAYER_DANGLING;
  aLayers[1] = Type() == SCH_BUS_BUS_ENTRY_T ? LAYER_BUS : LAYER_WIRE;
  aLayers[2] = LAYER_SELECTION_SHADOWS;
 }

References LAYER_BUS, LAYER_DANGLING, LAYER_SELECTION_SHADOWS, LAYER_WIRE, SCH_BUS_BUS_ENTRY_T, and EDA_ITEM::Type().

◆ ViewGetLOD()

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

inlinevirtualinherited

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

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

Parameters

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

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

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

Definition at line 132 of file view_item.h.

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

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

◆ viewPrivData()

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

inlineinherited

Definition at line 138 of file view_item.h.

  {
  return m_viewPrivData;
  }

References KIGFX::VIEW_ITEM::m_viewPrivData.

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

◆ Visit()

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

virtualinherited

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

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

Parameters

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

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

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

Definition at line 93 of file eda_item.cpp.

 {
 #if 0 && defined(DEBUG)
  std::cout << GetClass().mb_str() << ' ';
 #endif
 
  if( IsType( scanTypes ) )
  {
  if( SEARCH_RESULT::QUIT == inspector( this, testData ) )
  return SEARCH_RESULT::QUIT;
  }
 
  return SEARCH_RESULT::CONTINUE;
 }

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

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

Member Data Documentation

◆ m_connected_bus_items

SCH_ITEM* SCH_BUS_BUS_ENTRY::m_connected_bus_items[2]

Pointer to the bus items (usually bus wires) connected to this bus-bus entry (either or both may be nullptr)

Definition at line 239 of file sch_bus_entry.h.

Referenced by SCH_BUS_BUS_ENTRY().

◆ m_connected_items

std::unordered_map<SCH_SHEET_PATH, SCH_ITEM_SET> SCH_ITEM::m_connected_items

protectedinherited

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

Definition at line 494 of file sch_item.h.

Referenced by SCH_ITEM::AddConnectionTo(), SCH_ITEM::ConnectedItems(), and SCH_LABEL::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 497 of file sch_item.h.

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

◆ m_connections

EDA_ITEMS SCH_ITEM::m_connections

protectedinherited

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

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

◆ m_fieldsAutoplaced

FIELDS_AUTOPLACED SCH_ITEM::m_fieldsAutoplaced

protectedinherited

Definition at line 489 of file sch_item.h.

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

◆ m_flags

EDA_ITEM_FLAGS EDA_ITEM::m_flags

protectedinherited

Definition at line 480 of file eda_item.h.

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

◆ m_forceVisible

bool EDA_ITEM::m_forceVisible

protectedinherited

Definition at line 479 of file eda_item.h.

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

◆ m_isDanglingEnd

bool SCH_BUS_ENTRY_BASE::m_isDanglingEnd

protectedinherited

Definition at line 136 of file sch_bus_entry.h.

Referenced by SCH_BUS_ENTRY_BASE::IsDangling(), SCH_BUS_ENTRY_BASE::IsDanglingEnd(), SCH_BUS_ENTRY_BASE::SCH_BUS_ENTRY_BASE(), SCH_BUS_WIRE_ENTRY::UpdateDanglingState(), and UpdateDanglingState().

◆ m_isDanglingStart

bool SCH_BUS_ENTRY_BASE::m_isDanglingStart

protectedinherited

Definition at line 135 of file sch_bus_entry.h.

Referenced by SCH_BUS_ENTRY_BASE::IsDangling(), SCH_BUS_ENTRY_BASE::IsDanglingStart(), SCH_BUS_ENTRY_BASE::SCH_BUS_ENTRY_BASE(), SCH_BUS_WIRE_ENTRY::UpdateDanglingState(), and UpdateDanglingState().

◆ m_lastResolvedColor

COLOR4D SCH_BUS_ENTRY_BASE::m_lastResolvedColor

mutableprotectedinherited

Definition at line 144 of file sch_bus_entry.h.

Referenced by SCH_BUS_ENTRY_BASE::GetStrokeColor(), SCH_BUS_BUS_ENTRY(), SCH_BUS_ENTRY_BASE::SCH_BUS_ENTRY_BASE(), SCH_BUS_WIRE_ENTRY::SCH_BUS_WIRE_ENTRY(), SCH_BUS_ENTRY_BASE::SetLastResolvedState(), and SCH_BUS_ENTRY_BASE::SwapData().

◆ m_lastResolvedLineStyle

PLOT_DASH_TYPE SCH_BUS_ENTRY_BASE::m_lastResolvedLineStyle

mutableprotectedinherited

Definition at line 142 of file sch_bus_entry.h.

Referenced by SCH_BUS_ENTRY_BASE::GetStrokeStyle(), SCH_BUS_BUS_ENTRY(), SCH_BUS_ENTRY_BASE::SCH_BUS_ENTRY_BASE(), SCH_BUS_WIRE_ENTRY::SCH_BUS_WIRE_ENTRY(), SCH_BUS_ENTRY_BASE::SetLastResolvedState(), and SCH_BUS_ENTRY_BASE::SwapData().

◆ m_lastResolvedWidth

int SCH_BUS_ENTRY_BASE::m_lastResolvedWidth

mutableprotectedinherited

Definition at line 143 of file sch_bus_entry.h.

Referenced by SCH_BUS_WIRE_ENTRY::GetPenWidth(), GetPenWidth(), SCH_BUS_BUS_ENTRY(), SCH_BUS_ENTRY_BASE::SCH_BUS_ENTRY_BASE(), SCH_BUS_WIRE_ENTRY::SCH_BUS_WIRE_ENTRY(), SCH_BUS_ENTRY_BASE::SetLastResolvedState(), and SCH_BUS_ENTRY_BASE::SwapData().

◆ m_layer

SCH_LAYER_ID SCH_ITEM::m_layer

protectedinherited

Definition at line 487 of file sch_item.h.

Referenced by SCH_LINE::CanConnect(), SCH_ITEM::CanConnect(), SCH_LINE::doIsConnected(), SCH_ITEM::GetLayer(), SCH_LINE::GetMenuImage(), SCH_LINE::GetPenWidth(), SCH_LINE::GetSelectMenuText(), SCH_LINE::IsConnectable(), SCH_LINE::IsType(), SCH_ITEM::operator=(), SCH_BUS_ENTRY_BASE::Plot(), SCH_TEXT::Plot(), SCH_BUS_ENTRY_BASE::Print(), SCH_FIELD::Print(), SCH_TEXT::Print(), SCH_GLOBALLABEL::Print(), SCH_HIERLABEL::Print(), SCH_BITMAP::SCH_BITMAP(), SCH_BUS_BUS_ENTRY(), SCH_BUS_WIRE_ENTRY::SCH_BUS_WIRE_ENTRY(), SCH_HIERLABEL::SCH_HIERLABEL(), SCH_ITEM::SCH_ITEM(), SCH_JUNCTION::SCH_JUNCTION(), SCH_LABEL::SCH_LABEL(), SCH_LINE::SCH_LINE(), SCH_SHEET::SCH_SHEET(), SCH_SHEET_PIN::SCH_SHEET_PIN(), SCH_TEXT::SCH_TEXT(), SCH_ITEM::SetLayer(), SCH_FIELD::SwapData(), SCH_TEXT::SwapData(), SCH_LINE::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 478 of file eda_item.h.

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

◆ m_pos

◆ m_size

wxSize SCH_BUS_ENTRY_BASE::m_size

protectedinherited

Definition at line 134 of file sch_bus_entry.h.

Referenced by SCH_BUS_ENTRY_BASE::GetEnd(), SCH_BUS_ENTRY_BASE::GetSize(), SCH_BUS_ENTRY_BASE::MirrorHorizontally(), SCH_BUS_ENTRY_BASE::MirrorVertically(), SCH_BUS_ENTRY_BASE::Rotate(), SCH_BUS_ENTRY_BASE::SCH_BUS_ENTRY_BASE(), SCH_BUS_WIRE_ENTRY::SCH_BUS_WIRE_ENTRY(), SCH_BUS_ENTRY_BASE::SetSize(), and SCH_BUS_ENTRY_BASE::SwapData().

◆ m_status

EDA_ITEM_FLAGS EDA_ITEM::m_status

protectedinherited

Definition at line 477 of file eda_item.h.

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

◆ m_storedPos

wxPoint SCH_ITEM::m_storedPos

protectedinherited

Definition at line 490 of file sch_item.h.

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

◆ m_stroke

STROKE_PARAMS SCH_BUS_ENTRY_BASE::m_stroke

protectedinherited

Definition at line 137 of file sch_bus_entry.h.

Referenced by SCH_BUS_WIRE_ENTRY::GetPenWidth(), GetPenWidth(), SCH_BUS_ENTRY_BASE::GetStroke(), SCH_BUS_ENTRY_BASE::GetStrokeColor(), SCH_BUS_ENTRY_BASE::GetStrokeStyle(), SCH_BUS_ENTRY_BASE::SCH_BUS_ENTRY_BASE(), SCH_BUS_ENTRY_BASE::SetPenWidth(), SCH_BUS_ENTRY_BASE::SetStroke(), SCH_BUS_ENTRY_BASE::SetStrokeColor(), SCH_BUS_ENTRY_BASE::SetStrokeStyle(), and SCH_BUS_ENTRY_BASE::SwapData().

◆ m_Uuid

const KIID EDA_ITEM::m_Uuid

inherited

Definition at line 474 of file eda_item.h.

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

Detailed Description

Constructor & Destructor Documentation

◆ SCH_BUS_BUS_ENTRY()

◆ ~SCH_BUS_BUS_ENTRY()

Member Function Documentation

◆ AddConnectionTo()

◆ AutoAutoplaceFields()

◆ AutoplaceFields()

◆ CanConnect()

◆ ClassOf()

◆ ClearBrightened()

◆ ClearConnections()

◆ ClearEditFlags()

◆ ClearFieldsAutoplaced()

◆ ClearFlags()

◆ ClearSelected()

◆ ClearTempFlags()

◆ ClearViewPrivData()

◆ Clone()

◆ ConnectedItems()

◆ Connection()

◆ ConnectionPropagatesTo()

◆ DoHypertextMenu()

◆ Duplicate()

◆ Get() [1/3]

◆ Get() [2/3]

◆ Get() [3/3]

◆ GetBoundingBox()

◆ GetClass()

◆ GetConnectionPoints()

◆ GetEditFlags()

◆ GetEnd()

◆ GetEndPoints()

◆ GetFieldsAutoplaced()

◆ GetFlags()

◆ GetFocusPosition()

◆ GetLayer()

◆ GetMenuImage()

◆ GetMsgPanelInfo()

◆ GetOrInitConnection()

◆ GetParent()

◆ GetPenWidth()

◆ GetPosition()

◆ GetSelectMenuText()

◆ GetSize()

◆ GetState()

◆ GetStatus()

◆ GetStoredPos()

◆ GetStroke()

◆ GetStrokeColor()

◆ GetStrokeStyle()

◆ HasFlag()

◆ HasLineStroke()

◆ HitTest() [1/2]

◆ HitTest() [2/2]

◆ InitializeConnection()

◆ IsBrightened()

◆ IsConnectable()

◆ IsConnected()

◆ IsConnectivityDirty()

◆ IsDangling()

◆ IsDanglingEnd()

◆ IsDanglingStart()

◆ IsDragging()

◆ IsEntered()

◆ IsForceVisible()

◆ IsHypertext()

◆ IsLocked()

◆ IsModified()

◆ IsMovableFromAnchorPoint()

◆ IsMoving()

◆ IsNew()

◆ IsPointClickableAnchor()

◆ IsReplaceable()

◆ IsResized()