#include <class_pcb_target.h>

Inheritance diagram for PCB_TARGET:

Public Member Functions
	PCB_TARGET (BOARD_ITEM *aParent)

	PCB_TARGET (BOARD_ITEM *aParent, int aShape, PCB_LAYER_ID aLayer, const wxPoint &aPos, int aSize, int aWidth)

	~PCB_TARGET ()

void	SetPosition (const wxPoint &aPos) override

const wxPoint	GetPosition () const override

void	SetShape (int aShape)

int	GetShape () const

void	SetSize (int aSize)

int	GetSize () const

void	SetWidth (int aWidth)

int	GetWidth () const

void	Move (const wxPoint &aMoveVector) override
	Function Move move this object. More...

void	Rotate (const wxPoint &aRotCentre, double aAngle) override
	Function Rotate Rotate this object. More...

void	Flip (const wxPoint &aCentre) override
	Function Flip Flip this object, i.e. More...

void	Draw (EDA_DRAW_PANEL panel, wxDC DC, GR_DRAWMODE aDrawMode, const wxPoint &offset=ZeroOffset) override
	Function Draw BOARD_ITEMs have their own color information. More...

bool	HitTest (const wxPoint &aPosition) const override
	Function HitTest tests if aPosition is contained within or on the bounding area of an item. More...

wxString	GetClass () const override
	Function GetClass returns the class name. More...

bool	HitTest (const EDA_RECT &aRect, bool aContained=true, int aAccuracy=0) const override

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

wxString	GetSelectMenuText (EDA_UNITS_T aUnits) const override
	Function GetSelectMenuText returns the text to display to be used in the selection clarification context menu when multiple items are found at the current cursor position. More...

BITMAP_DEF	GetMenuImage () const override
	Function GetMenuImage returns a pointer to an image to be used in menus. More...

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

virtual void	SwapData (BOARD_ITEM *aImage) override
	Swap data between aItem and aImage. More...

virtual const wxPoint	GetCenter () const
	Function GetCenter() More...

virtual bool	IsConnected () const
	Function IsConnected() Returns information if the object is derived from BOARD_CONNECTED_ITEM. More...

BOARD_ITEM *	Next () const

BOARD_ITEM *	Back () const

BOARD_ITEM_CONTAINER *	GetParent () const

virtual PCB_LAYER_ID	GetLayer () const
	Function GetLayer returns the primary layer this item is on. More...

virtual LSET	GetLayerSet () const
	Function GetLayerSet returns a "layer mask", which is a bitmap of all layers on which the TRACK segment or VIA physically resides. More...

virtual void	SetLayer (PCB_LAYER_ID aLayer)
	Function SetLayer sets the layer this item is on. More...

virtual bool	IsOnLayer (PCB_LAYER_ID aLayer) const
	Function IsOnLayer tests to see if this object is on the given layer. More...

bool	IsTrack () const
	Function IsTrack tests to see if this object is a track or via (or microvia). More...

virtual bool	IsLocked () const
	Function IsLocked. More...

virtual void	SetLocked (bool aLocked)
	Function SetLocked modifies 'lock' status for of the item. More...

virtual void	UnLink ()
	Function UnLink detaches this object from its owner. More...

void	DeleteStructure ()
	Function DeleteStructure deletes this object after UnLink()ing it from its owner if it has one. More...

void	Move (const VECTOR2I &aMoveVector)

void	Rotate (const VECTOR2I &aRotCentre, double aAngle)

void	Flip (const VECTOR2I &aCentre)

virtual BOARD *	GetBoard () const
	Function GetBoard returns the BOARD in which this BOARD_ITEM resides, or NULL if none. More...

wxString	GetLayerName () const
	Function GetLayerName returns the name of the PCB layer on which the item resides. More...

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

virtual void	TransformShapeWithClearanceToPolygon (SHAPE_POLY_SET &aCornerBuffer, int aClearanceValue, int aCircleToSegmentsCount, double aCorrectionFactor, bool ignoreLineWidth=false) const
	Function TransformShapeWithClearanceToPolygon Convert the item shape to a closed polygon Used in filling zones calculations Circles and arcs are approximated by segments. More...

KICAD_T	Type () const
	Function Type() More...

void	SetTimeStamp (timestamp_t aNewTimeStamp)

timestamp_t	GetTimeStamp () const

DHEAD *	GetList () const

void	SetNext (EDA_ITEM *aNext)

void	SetBack (EDA_ITEM *aBack)

void	SetParent (EDA_ITEM *aParent)

void	SetList (DHEAD *aList)

bool	IsNew () const

bool	IsModified () const

bool	IsMoving () const

bool	IsDragging () const

bool	IsWireImage () const

bool	IsSelected () const

bool	IsResized () const

bool	IsHighlighted () const

bool	IsBrightened () const

void	SetWireImage ()

void	SetSelected ()

void	SetHighlighted ()

void	SetBrightened ()

void	ClearSelected ()

void	ClearHighlighted ()

void	ClearBrightened ()

void	SetModified ()

int	GetState (int type) const

void	SetState (int type, int state)

STATUS_FLAGS	GetStatus () const

void	SetStatus (STATUS_FLAGS aStatus)

void	SetFlags (STATUS_FLAGS aMask)

void	ClearFlags (STATUS_FLAGS aMask=EDA_ITEM_ALL_FLAGS)

STATUS_FLAGS	GetFlags () const

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

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

virtual void	GetMsgPanelInfo (EDA_UNITS_T aUnits, std::vector< MSG_PANEL_ITEM > &aList)
	Function GetMsgPanelInfo populates aList of MSG_PANEL_ITEM objects with it's internal state for display purposes. More...

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

virtual bool	Matches (wxFindReplaceData &aSearchData, void aAuxData, wxPoint aFindLocation)
	Function Matches compares the item against the search criteria in aSearchData. More...

bool	Replace (wxFindReplaceData &aSearchData, wxString &aText)
	Helper function used in search and replace dialog Function Replace performs a text replace on aText using the find and replace criteria in aSearchData on items that support text find and replace. More...

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

virtual bool	IsReplaceable () const
	Function IsReplaceable. More...

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

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

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

virtual unsigned int	ViewGetLOD (int aLayer, VIEW *aView) const
	Function ViewGetLOD() Returns the level of detail (LOD) of the item. More...

VIEW_ITEM_DATA *	viewPrivData () const

void	ClearViewPrivData ()

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

static wxString	ShowShape (STROKE_T aShape)
	Function ShowShape converts the enum STROKE_T integer value to a wxString. More...

static SEARCH_RESULT	IterateForward (EDA_ITEM listStart, INSPECTOR inspector, void testData, const KICAD_T scanTypes[])
	Function IterateForward walks through the object tree calling the inspector() on each object type requested in scanTypes. More...

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

Static Public Attributes
static wxPoint	ZeroOffset
	A value of wxPoint(0,0) which can be passed to the Draw() functions. More...

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

Static Protected Member Functions
static int	getNextNumberInSequence (const std::set< int > &aSeq, bool aFillSequenceGaps)

Protected Attributes
PCB_LAYER_ID	m_Layer

EDA_ITEM *	Pnext
	next in linked list More...

EDA_ITEM *	Pback
	previous in linked list More...

DHEAD *	m_List
	which DLIST I am on. More...

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

timestamp_t	m_TimeStamp
	Time stamp used for logical links. More...

bool	m_forceVisible
	Set to true to override the visibility setting of the item. More...

STATUS_FLAGS	m_Flags
	Flag bits for editing and other uses. More...

Private Attributes
int	m_Shape

int	m_Size

int	m_Width

wxPoint	m_Pos

Detailed Description

Definition at line 41 of file class_pcb_target.h.

Constructor & Destructor Documentation

◆ PCB_TARGET() [1/2]

PCB_TARGET::PCB_TARGET ( BOARD_ITEM * aParent )

Definition at line 48 of file class_pcb_target.cpp.

                                             :
     BOARD_ITEM( aParent, PCB_TARGET_T )
 {
     m_Shape = 0;
     m_Size  = Millimeter2iu( 5 );       // Gives a decent size
     m_Width = Millimeter2iu( DEFAULT_COPPER_LINE_WIDTH );
     m_Layer = Edge_Cuts;                   // a target is on all layers
 }

References DEFAULT_COPPER_LINE_WIDTH, Edge_Cuts, BOARD_ITEM::m_Layer, m_Shape, m_Size, and m_Width.

Referenced by Clone().

◆ PCB_TARGET() [2/2]

PCB_TARGET::PCB_TARGET	(	BOARD_ITEM *	aParent,
		int	aShape,
		PCB_LAYER_ID	aLayer,
		const wxPoint &	aPos,
		int	aSize,
		int	aWidth
	)

Definition at line 57 of file class_pcb_target.cpp.

                                                      :
     BOARD_ITEM( aParent, PCB_TARGET_T )
 {
     m_Shape = aShape;
     m_Layer = aLayer;
     m_Pos   = aPos;
     m_Size  = aSize;
     m_Width = aWidth;
 }

References BOARD_ITEM::m_Layer, m_Pos, m_Shape, m_Size, and m_Width.

◆ ~PCB_TARGET()

PCB_TARGET::~PCB_TARGET ( )

Definition at line 69 of file class_pcb_target.cpp.

70 {

71 }

Member Function Documentation

◆ Back()

BOARD_ITEM* BOARD_ITEM::Back ( ) const

inlineinherited

Definition at line 116 of file class_board_item.h.

116 { return static_cast<BOARD_ITEM*>( Pback ); }

EDA_ITEM::Pback

EDA_ITEM * Pback

previous in linked list

Definition: base_struct.h:168

References EDA_ITEM::Pback.

Referenced by SwapItemData().

◆ ClassOf()

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

inlinestatic

Definition at line 61 of file class_pcb_target.h.

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

References PCB_TARGET_T, and EDA_ITEM::Type().

◆ ClearBrightened()

void EDA_ITEM::ClearBrightened ( )

inlineinherited

Definition at line 236 of file base_struct.h.

236 { ClearFlags( BRIGHTENED ); }

BRIGHTENED

#define BRIGHTENED

item is drawn with a bright contour

Definition: base_struct.h:138

EDA_ITEM::ClearFlags

void ClearFlags(STATUS_FLAGS aMask=EDA_ITEM_ALL_FLAGS)

Definition: base_struct.h:257

References BRIGHTENED, and EDA_ITEM::ClearFlags().

Referenced by GERBVIEW_SELECTION_TOOL::disambiguationMenu(), and SELECTION_TOOL::unhighlight().

◆ ClearFlags()

void EDA_ITEM::ClearFlags ( STATUS_FLAGS aMask = EDA_ITEM_ALL_FLAGS )

inlineinherited

Definition at line 257 of file base_struct.h.

257 { m_Flags &= ~aMask; }

EDA_ITEM::m_Flags

STATUS_FLAGS m_Flags

Flag bits for editing and other uses.

Definition: base_struct.h:178

References EDA_ITEM::m_Flags.

◆ ClearHighlighted()

void EDA_ITEM::ClearHighlighted ( )

inlineinherited

Definition at line 235 of file base_struct.h.

235 { ClearFlags( HIGHLIGHTED ); }

HIGHLIGHTED

#define HIGHLIGHTED

item is drawn in normal colors, when the rest is darkened

Definition: base_struct.h:137

EDA_ITEM::ClearFlags

void ClearFlags(STATUS_FLAGS aMask=EDA_ITEM_ALL_FLAGS)

Definition: base_struct.h:257

References EDA_ITEM::ClearFlags(), and HIGHLIGHTED.

◆ ClearSelected()

void EDA_ITEM::ClearSelected ( )

inlineinherited

Definition at line 234 of file base_struct.h.

234 { ClearFlags( SELECTED ); }

SELECTED

#define SELECTED

Definition: base_struct.h:121

EDA_ITEM::ClearFlags

void ClearFlags(STATUS_FLAGS aMask=EDA_ITEM_ALL_FLAGS)

Definition: base_struct.h:257

References EDA_ITEM::ClearFlags(), and SELECTED.

Referenced by POINT_EDITOR::addCorner(), EDIT_TOOL::Duplicate(), GAL_ARRAY_CREATOR::prePushAction(), SELECTION_TOOL::unhighlight(), and GERBVIEW_SELECTION_TOOL::unselectVisually().

◆ ClearViewPrivData()

void KIGFX::VIEW_ITEM::ClearViewPrivData ( )

inlineinherited

Definition at line 153 of file view_item.h.

     {
         m_viewPrivData = NULL;
     }

References KIGFX::VIEW_ITEM::m_viewPrivData.

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

◆ Clone()

EDA_ITEM * PCB_TARGET::Clone ( ) const

overridevirtual

Function Clone creates a duplicate of this item with linked list members set to NULL.

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

Returns: A clone of the item.

Reimplemented from EDA_ITEM.

Definition at line 198 of file class_pcb_target.cpp.

 {
     return new PCB_TARGET( *this );
 }

References PCB_TARGET().

◆ DeleteStructure()

void BOARD_ITEM::DeleteStructure ( )

inherited

Function DeleteStructure deletes this object after UnLink()ing it from its owner if it has one.

Definition at line 127 of file class_board_item.cpp.

 {
     auto parent = GetParent();
 
     if( parent && GetList() )
         parent->Remove( this );
 
     delete this;
 }

References EDA_ITEM::GetList(), and BOARD_ITEM::GetParent().

Referenced by Abort_Edit_Pcb_Text(), Abort_EditEdge(), Abort_Move_ModuleOutline(), Abort_MoveOrCopyModule(), AbortBuildDimension(), AbortMoveAndEditTarget(), PCB_EDIT_FRAME::Block_Delete(), PCB_EDIT_FRAME::CreateTextePcb(), FOOTPRINT_EDIT_FRAME::Delete_Edge_Module(), PCB_EDIT_FRAME::Delete_Segment_Edge(), DeleteMarkedItems(), PCB_BASE_FRAME::DeleteTextModule(), PCB_EDIT_FRAME::End_Edge(), FOOTPRINT_EDIT_FRAME::End_Edge_Module(), BOARD::PadDelete(), DIALOG_FOOTPRINT_FP_EDITOR::TransferDataFromWindow(), and DIALOG_FOOTPRINT_BOARD_EDITOR::TransferDataFromWindow().

◆ Draw()

void PCB_TARGET::Draw	(	EDA_DRAW_PANEL *	panel,
		wxDC *	DC,
		GR_DRAWMODE	aDrawMode,
		const wxPoint &	offset = `ZeroOffset`
	)

overridevirtual

Function Draw BOARD_ITEMs have their own color information.

Implements BOARD_ITEM.

Definition at line 78 of file class_pcb_target.cpp.

 {
     int radius, ox, oy, width;
     int dx1, dx2, dy1, dy2;
 
     ox = m_Pos.x + offset.x;
     oy = m_Pos.y + offset.y;
 
     BOARD * brd =  GetBoard( );
 
     if( brd->IsLayerVisible( m_Layer ) == false )
         return;
 
     auto frame = static_cast<PCB_EDIT_FRAME*> ( panel->GetParent() );
     auto gcolor = frame->Settings().Colors().GetLayerColor( m_Layer );
 
     GRSetDrawMode( DC, mode_color );
     auto displ_opts = (PCB_DISPLAY_OPTIONS*)( panel->GetDisplayOptions() );
     bool filled = displ_opts ? displ_opts->m_DisplayDrawItemsFill : FILLED;
     width   = m_Width;
 
     radius = m_Size / 3;
 
     if( GetShape() )   // shape X
         radius = m_Size / 2;
 
     if( filled )
         GRCircle( panel->GetClipBox(), DC, ox, oy, radius, width, gcolor );
     else
     {
         GRCircle( panel->GetClipBox(), DC, ox, oy, radius + (width / 2), gcolor );
         GRCircle( panel->GetClipBox(), DC, ox, oy, radius - (width / 2), gcolor );
     }
 
 
     radius = m_Size / 2;
     dx1   = radius;
     dy1   = 0;
     dx2   = 0;
     dy2   = radius;
 
     if( GetShape() )   // shape X
     {
         dx1 = dy1 = radius;
         dx2 = dx1;
         dy2 = -dy1;
     }
 
     if( filled )
     {
         GRLine( panel->GetClipBox(), DC, ox - dx1, oy - dy1, ox + dx1, oy + dy1, width, gcolor );
         GRLine( panel->GetClipBox(), DC, ox - dx2, oy - dy2, ox + dx2, oy + dy2, width, gcolor );
     }
     else
     {
         GRCSegm( panel->GetClipBox(), DC, ox - dx1, oy - dy1, ox + dx1, oy + dy1, width, gcolor );
         GRCSegm( panel->GetClipBox(), DC, ox - dx2, oy - dy2, ox + dx2, oy + dy2, width, gcolor );
     }
 }

References FILLED, BOARD_ITEM::GetBoard(), EDA_DRAW_PANEL::GetClipBox(), EDA_DRAW_PANEL::GetDisplayOptions(), EDA_DRAW_PANEL::GetParent(), GetShape(), GRCircle(), GRCSegm(), GRLine(), GRSetDrawMode(), BOARD::IsLayerVisible(), BOARD_ITEM::m_Layer, m_Pos, m_Size, and m_Width.

Referenced by AbortMoveAndEditTarget(), PCB_EDIT_FRAME::DeleteTarget(), PCB_EDIT_FRAME::PlaceTarget(), ShowTargetShapeWhileMovingMouse(), and DIALOG_TARGET_PROPERTIES::TransferDataFromWindow().

◆ Flip() [1/2]

void PCB_TARGET::Flip ( const wxPoint & aCentre )

overridevirtual

Function Flip Flip this object, i.e.

change the board side for this object

Parameters

aCentre - the rotation point.

Reimplemented from BOARD_ITEM.

Definition at line 167 of file class_pcb_target.cpp.

 {
     m_Pos.y  = aCentre.y - ( m_Pos.y - aCentre.y );
     SetLayer( FlipLayer( GetLayer() ) );
 }

References FlipLayer(), BOARD_ITEM::GetLayer(), m_Pos, and BOARD_ITEM::SetLayer().

◆ Flip() [2/2]

void BOARD_ITEM::Flip ( const VECTOR2I & aCentre )

inlineinherited

Definition at line 270 of file class_board_item.h.

     {
         Flip( wxPoint( aCentre.x, aCentre.y ) );
     }

References BOARD_ITEM::Flip(), VECTOR2< T >::x, and VECTOR2< T >::y.

◆ GetBoard()

BOARD * BOARD_ITEM::GetBoard ( ) const

virtualinherited

Function GetBoard returns the BOARD in which this BOARD_ITEM resides, or NULL if none.

Definition at line 64 of file class_board_item.cpp.

 {
     if( Type() == PCB_T )
         return (BOARD*) this;
 
     BOARD_ITEM* parent = GetParent();
 
     if( parent )
         return parent->GetBoard();
 
     return NULL;
 }

References BOARD_ITEM::GetBoard(), BOARD_ITEM::GetParent(), PCB_T, and EDA_ITEM::Type().

Referenced by DeleteMarkedItems(), TEXTE_PCB::Draw(), Draw(), ZONE_CONTAINER::Draw(), EDGE_MODULE::Draw(), TEXTE_MODULE::Draw(), TRACK::Draw(), DIMENSION::Draw(), DRAWSEGMENT::Draw(), MODULE::Draw(), SEGZONE::Draw(), VIA::Draw(), D_PAD::Draw(), MODULE::DrawAncre(), ZONE_CONTAINER::DrawFilledArea(), TEXTE_PCB::Flip(), TRACK::Flip(), ZONE_CONTAINER::Flip(), VIA::Flip(), BOARD_ITEM::GetBoard(), MODULE::GetBoundingPoly(), BOARD_ITEM::GetLayerName(), PCB_DRAW_PANEL_GAL::GetMsgPanelInfo(), TRACK::GetMsgPanelInfo(), NETINFO_ITEM::GetMsgPanelInfo(), D_PAD::GetMsgPanelInfo(), TRACK::GetMsgPanelInfoBase(), SEGZONE::GetMsgPanelInfoBase(), VIA::GetMsgPanelInfoBase(), TRACK::GetMsgPanelInfoBase_Common(), BOARD_CONNECTED_ITEM::GetNetClass(), BOARD_CONNECTED_ITEM::GetNetnameMsg(), VIA::GetSelectMenuText(), D_PAD::GetSelectMenuText(), D_PAD::GetSolderMaskMargin(), D_PAD::GetSolderPasteMargin(), EAGLE_PLUGIN::packageWire(), PushTrack(), BOARD_CONNECTED_ITEM::SetNet(), BOARD_CONNECTED_ITEM::SetNetCode(), MODULE::ViewBBox(), VIA::ViewGetLOD(), and D_PAD::ViewGetLOD().

◆ GetBoundingBox()

const EDA_RECT PCB_TARGET::GetBoundingBox ( ) const

overridevirtual

Function GetBoundingBox returns the orthogonal, bounding box of this object for display purposes.

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

Reimplemented from EDA_ITEM.

Definition at line 174 of file class_pcb_target.cpp.

 {
     EDA_RECT bBox;
     bBox.SetX( m_Pos.x - m_Size/2 );
     bBox.SetY( m_Pos.y - m_Size/2 );
     bBox.SetWidth( m_Size );
     bBox.SetHeight( m_Size );
 
     return bBox;
 }

References m_Pos, m_Size, EDA_RECT::SetHeight(), EDA_RECT::SetWidth(), EDA_RECT::SetX(), and EDA_RECT::SetY().

Referenced by HitTest().

◆ GetCenter()

virtual const wxPoint BOARD_ITEM::GetCenter ( ) const

inlinevirtualinherited

Function GetCenter()

This defaults to the same point as returned by GetPosition(), unless overridden

Returns: centre point of the item

Reimplemented in DRAWSEGMENT.

Definition at line 96 of file class_board_item.h.

96 { return GetPosition(); }

BOARD_ITEM::GetPosition

virtual const wxPoint GetPosition() const =0

References BOARD_ITEM::GetPosition().

Referenced by BOARD::chainMarkedSegments(), and LEGACY_ARRAY_CREATOR::getRotationCentre().

◆ GetClass()

wxString PCB_TARGET::GetClass ( ) const

inlineoverridevirtual

Function GetClass returns the class name.

Returns: wxString

Implements EDA_ITEM.

Definition at line 92 of file class_pcb_target.h.

     {
         return wxT( "PCB_TARGET" );
     }

◆ GetFlags()

STATUS_FLAGS EDA_ITEM::GetFlags ( ) const

inlineinherited

Definition at line 258 of file base_struct.h.

258 { return m_Flags; }

EDA_ITEM::m_Flags

STATUS_FLAGS m_Flags

Flag bits for editing and other uses.

Definition: base_struct.h:178

References EDA_ITEM::m_Flags.

◆ GetLayer()

virtual PCB_LAYER_ID BOARD_ITEM::GetLayer ( ) const

inlinevirtualinherited

Function GetLayer returns the primary layer this item is on.

Reimplemented in ZONE_CONTAINER.

Definition at line 123 of file class_board_item.h.

123 { return m_Layer; }

BOARD_ITEM::m_Layer

PCB_LAYER_ID m_Layer

Definition: class_board_item.h:72

References BOARD_ITEM::m_Layer.

Referenced by Abort_MoveOrCopyModule(), DIALOG_GLOBAL_DELETION::AcceptPcbDelete(), CN_CONNECTIVITY_ALGO::Add(), CN_LIST::Add(), CINFO3D_VISU::AddGraphicsShapesWithClearanceToContainer(), DIMENSION::AdjustDimensionDetails(), PCB_EDIT_FRAME::Begin_DrawSegment(), FOOTPRINT_EDIT_FRAME::Begin_Edge_Module(), AR_AUTOPLACER::buildFpAreas(), PCB_EDIT_FRAME::Change_Side_Module(), checkConnectedTo(), MODULE::CopyNetlistSettings(), CreateBoardSection(), MWAVE::CreateMicrowaveInductor(), CreateRoutesSection(), DIALOG_GRAPHIC_ITEM_PROPERTIES::DIALOG_GRAPHIC_ITEM_PROPERTIES(), DIALOG_TEXT_PROPERTIES::DIALOG_TEXT_PROPERTIES(), DIALOG_TRACK_VIA_PROPERTIES::DIALOG_TRACK_VIA_PROPERTIES(), PCB_EDIT_FRAME::DoGenFootprintsPositionFile(), DRC::doTrackKeepoutDrc(), TEXTE_MODULE::Draw(), DRAWSEGMENT::Draw(), KIGFX::PCB_PAINTER::draw(), FOOTPRINT_EDIT_FRAME::Edit_Edge_Layer(), FOOTPRINT_EDIT_FRAME::Edit_Edge_Width(), export_vrml_drawsegment(), export_vrml_edge_module(), export_vrml_module(), export_vrml_pcbtext(), export_vrml_text_module(), PCB_EDIT_FRAME::ExportToGenCAD(), TEXTE_PCB::Flip(), Flip(), EDGE_MODULE::Flip(), TEXTE_MODULE::Flip(), TRACK::Flip(), DIMENSION::Flip(), MODULE::Flip(), DRAWSEGMENT::Flip(), PCB_IO::FootprintSave(), FootprintWriteShape(), PCB_IO::formatLayer(), DSN::SPECCTRA_DB::FromBOARD(), AR_AUTOPLACER::genModuleOnRoutingMatrix(), BOARD::GetFootprint(), ZONE_CONTAINER::GetLayer(), AR_AUTOPLACER::getOptimalModulePlacement(), BOARD::GetPad(), TEXT_MOD_GRID_TABLE::GetValueAsLong(), BOARD::GetVisibleTrack(), SELECTION_TOOL::guessSelectionCandidates(), idf_export_module(), GENERAL_COLLECTOR::Inspect(), PCB_LAYER_COLLECTOR::Inspect(), D_PAD::IsFlipped(), MODULE::IsFlipped(), EDGE_MODULE::IsParentFlipped(), TEXTE_MODULE::IsParentFlipped(), itemIsIncludedByFilter(), FOOTPRINT_EDIT_FRAME::Load_Module_From_BOARD(), BOARD::MarkTrace(), DIALOG_FOOTPRINT_FP_EDITOR::OnAddField(), DIALOG_FOOTPRINT_BOARD_EDITOR::OnAddField(), PCB_EDIT_FRAME::OnRightClick(), EAGLE_PLUGIN::packagePad(), PCB_EDIT_FRAME::PlaceDraggedOrMovedTrackSegment(), BRDITEMS_PLOTTER::Plot_1_EdgeModule(), BRDITEMS_PLOTTER::Plot_Edges_Modules(), BRDITEMS_PLOTTER::PlotAllTextsModule(), BRDITEMS_PLOTTER::PlotDimension(), BRDITEMS_PLOTTER::PlotDrawSegment(), BRDITEMS_PLOTTER::PlotPcbTarget(), BRDITEMS_PLOTTER::PlotTextePcb(), processBoardItem(), DIALOG_GLOBAL_EDIT_TEXT_AND_GRAPHICS::processItem(), processTextItem(), TRACKS_CLEANER::removeDuplicatesOfTrack(), PCB_BASE_FRAME::ResetTextSize(), SELECTION_TOOL::selectable(), TEXT_MOD_GRID_TABLE::SetValueAsLong(), ShowClearance(), PNS_KICAD_IFACE::syncGraphicalItem(), PNS_KICAD_IFACE::syncTrack(), DRC::testCopperDrawItem(), DRC::testCopperTextAndGraphics(), DRC::testCopperTextItem(), DRC::testDisabledLayers(), AR_AUTOPLACER::testModuleOnBoard(), TEXTE_MODULE::TEXTE_MODULE(), AR_MATRIX::TraceSegmentPcb(), TraceSegmentPcb(), TrackListSortByNetcode(), DIALOG_FOOTPRINT_BOARD_EDITOR::TransferDataFromWindow(), DIALOG_TEXT_PROPERTIES::TransferDataToWindow(), DIALOG_GRAPHIC_ITEM_PROPERTIES::TransferDataToWindow(), DIALOG_FOOTPRINT_BOARD_EDITOR::TransferDataToWindow(), CINFO3D_VISU::transformGraphicModuleEdgeToPolygonSet(), MODULE::TransformGraphicShapesWithClearanceToPolygonSet(), MODULE::TransformGraphicTextWithClearanceToPolygonSet(), TEXTE_MODULE::ViewGetLayers(), TRACK::ViewGetLayers(), TEXTE_MODULE::ViewGetLOD(), DIALOG_GLOBAL_EDIT_TRACKS_AND_VIAS::visitItem(), and DIALOG_GLOBAL_EDIT_TEXT_AND_GRAPHICS::visitItem().

◆ GetLayerName()

wxString BOARD_ITEM::GetLayerName ( ) const

inherited

Function GetLayerName returns the name of the PCB layer on which the item resides.

Returns: wxString containing the layer name associated with this item.

Definition at line 78 of file class_board_item.cpp.

 {
     BOARD*  board = GetBoard();
 
     if( board )
         return board->GetLayerName( m_Layer );
 
     // If no parent, return standard name
     return BOARD::GetStandardLayerName( m_Layer );
 }

References BOARD_ITEM::GetBoard(), BOARD::GetLayerName(), BOARD::GetStandardLayerName(), and BOARD_ITEM::m_Layer.

Referenced by PCB_IO::format(), PCB_IO::formatLayer(), TEXTE_PCB::GetMsgPanelInfo(), ZONE_CONTAINER::GetMsgPanelInfo(), TEXTE_MODULE::GetMsgPanelInfo(), DRAWSEGMENT::GetMsgPanelInfo(), TEXTE_PCB::GetSelectMenuText(), EDGE_MODULE::GetSelectMenuText(), TEXTE_MODULE::GetSelectMenuText(), DIMENSION::GetSelectMenuText(), DRAWSEGMENT::GetSelectMenuText(), TRACK::GetSelectMenuText(), SEGZONE::GetSelectMenuText(), MODULE::GetSelectMenuText(), ZONE_CONTAINER::GetSelectMenuText(), and TEXT_MOD_GRID_TABLE::GetValue().

◆ GetLayerSet()

virtual LSET BOARD_ITEM::GetLayerSet ( ) const

inlinevirtualinherited

Function GetLayerSet returns a "layer mask", which is a bitmap of all layers on which the TRACK segment or VIA physically resides.

Returns: int - a layer mask, see layers_id_colors_visibility.h.

Reimplemented in D_PAD, VIA, and ZONE_CONTAINER.

Definition at line 131 of file class_board_item.h.

131 { return LSET( m_Layer ); }

BOARD_ITEM::m_Layer

PCB_LAYER_ID m_Layer

Definition: class_board_item.h:72

LSET

Class LSET is a set of PCB_LAYER_IDs.

Definition: layers_id_colors_and_visibility.h:381

References BOARD_ITEM::m_Layer.

Referenced by GRID_HELPER::BestSnapAnchor(), build_pad_testpoints(), BOARD::chainMarkedSegments(), Collect_TrackSegmentsToDrag(), DRC::doTrackDrc(), DRC::doTrackKeepoutDrc(), DRAWING_TOOL::DrawVia(), PCB_EDIT_FRAME::EraseRedundantTrack(), find_vias_and_tracks_at(), TRACK::GetEndSegments(), TRACK::GetTrack(), hash_board_item(), BOARD::MarkTrace(), POINT_EDITOR::OnSelectionChange(), and PCB_EDIT_FRAME::StartMoveOneNodeOrSegment().

◆ GetList()

DHEAD* EDA_ITEM::GetList ( ) const

inlineinherited

Definition at line 212 of file base_struct.h.

212 { return m_List; }

EDA_ITEM::m_List

DHEAD * m_List

which DLIST I am on.

Definition: base_struct.h:169

References EDA_ITEM::m_List.

Referenced by BOARD::CreateLockPoint(), BOARD_ITEM::DeleteStructure(), DHEAD::insert(), BOARD::MarkTrace(), DHEAD::remove(), SwapItemData(), BOARD_ITEM::UnLink(), and GERBER_DRAW_ITEM::UnLink().

◆ GetMenuImage()

BITMAP_DEF PCB_TARGET::GetMenuImage ( ) const

overridevirtual

Function GetMenuImage returns a pointer to an image to be used in menus.

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

Returns: The menu image associated with the item.

Reimplemented from EDA_ITEM.

Definition at line 193 of file class_pcb_target.cpp.

 {
     return  add_pcb_target_xpm;
 }

◆ GetMsgPanelInfo()

virtual void EDA_ITEM::GetMsgPanelInfo	(	EDA_UNITS_T	aUnits,
		std::vector< MSG_PANEL_ITEM > &	aList
	)

inlinevirtualinherited

Function GetMsgPanelInfo populates aList of MSG_PANEL_ITEM objects with it's internal state for display purposes.

Note: This method replaces DisplayInfo() so that KiCad objects no longer have any knowledge of wxWidgets UI objects.

Parameters

aList is the list to populate.

Reimplemented in BOARD, D_PAD, MODULE, SCH_SHEET, SCH_COMPONENT, NETINFO_ITEM, GERBER_DRAW_ITEM, LIB_ITEM, DIMENSION, TRACK, DRAWSEGMENT, SCH_TEXT, TEXTE_MODULE, LIB_FIELD, LIB_PIN, EDGE_MODULE, LIB_BEZIER, MARKER_PCB, LIB_ARC, ZONE_CONTAINER, LIB_TEXT, SCH_MARKER, LIB_POLYLINE, TEXTE_PCB, LIB_RECTANGLE, and LIB_CIRCLE.

Definition at line 297 of file base_struct.h.

298 {

299 }

Referenced by SCH_EDIT_FRAME::LocateItem(), EDA_DRAW_FRAME::SetMsgPanel(), FOOTPRINT_VIEWER_FRAME::UpdateMsgPanel(), FOOTPRINT_WIZARD_FRAME::UpdateMsgPanel(), PCB_BASE_FRAME::UpdateMsgPanel(), and FOOTPRINT_EDIT_FRAME::UpdateMsgPanel().

◆ getNextNumberInSequence()

int BOARD_ITEM::getNextNumberInSequence	(	const std::set< int > &	aSeq,
		bool	aFillSequenceGaps
	)

staticprotectedinherited

Definition at line 98 of file class_board_item.cpp.

 {
     if( aSeq.empty() )
         return 1;
 
     // By default go to the end of the sequence
     int candidate = *aSeq.rbegin();
 
     // Filling in gaps in pad numbering
     if( aFillSequenceGaps )
     {
         // start at the beginning
         candidate = *aSeq.begin();
 
         for( auto it : aSeq )
         {
             if( it - candidate > 1 )
                 break;
 
             candidate = it;
         }
     }
 
     ++candidate;
 
     return candidate;
 }

Referenced by MODULE::GetNextPadName().

◆ GetParent()

BOARD_ITEM_CONTAINER* BOARD_ITEM::GetParent ( void ) const

inlineinherited

Definition at line 117 of file class_board_item.h.

117 { return (BOARD_ITEM_CONTAINER*) m_Parent; }

EDA_ITEM::m_Parent

EDA_ITEM * m_Parent

Linked list: Link (parent struct)

Definition: base_struct.h:171

BOARD_ITEM_CONTAINER

Abstract interface for BOARD_ITEMs capable of storing other items inside.

Definition: board_item_container.h:39

References EDA_ITEM::m_Parent.

◆ GetPosition()

const wxPoint PCB_TARGET::GetPosition ( ) const

inlineoverridevirtual

Implements BOARD_ITEM.

Definition at line 67 of file class_pcb_target.h.

67 { return m_Pos; }

PCB_TARGET::m_Pos

wxPoint m_Pos

Definition: class_pcb_target.h:46

References m_Pos.

Referenced by AbortMoveAndEditTarget(), KIGFX::PCB_PAINTER::draw(), PCB_IO::format(), PCB_EDIT_FRAME::PlaceTarget(), and BRDITEMS_PLOTTER::PlotPcbTarget().

◆ GetSelectMenuText()

wxString PCB_TARGET::GetSelectMenuText ( EDA_UNITS_T aUnits ) const

overridevirtual

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

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

Returns: The menu text string.

Reimplemented from EDA_ITEM.

Definition at line 186 of file class_pcb_target.cpp.

 {
     // Targets are on *every* layer by definition
     return wxString::Format( _( "Target size %s" ), MessageTextFromValue( aUnits, m_Size ) );
 }

References Format(), m_Size, and MessageTextFromValue().

◆ GetShape()

int PCB_TARGET::GetShape ( ) const

inline

Definition at line 70 of file class_pcb_target.h.

70 { return m_Shape; }

PCB_TARGET::m_Shape

int m_Shape

Definition: class_pcb_target.h:43

References m_Shape.

Referenced by AbortMoveAndEditTarget(), Draw(), KIGFX::PCB_PAINTER::draw(), PCB_IO::format(), BRDITEMS_PLOTTER::PlotPcbTarget(), and DIALOG_TARGET_PROPERTIES::TransferDataToWindow().

◆ GetSize()

int PCB_TARGET::GetSize ( ) const

inline

Definition at line 73 of file class_pcb_target.h.

73 { return m_Size; }

PCB_TARGET::m_Size

int m_Size

Definition: class_pcb_target.h:44

References m_Size.

Referenced by AbortMoveAndEditTarget(), KIGFX::PCB_PAINTER::draw(), PCB_IO::format(), PCB_EDITOR_CONTROL::PlaceTarget(), BRDITEMS_PLOTTER::PlotPcbTarget(), and DIALOG_TARGET_PROPERTIES::TransferDataToWindow().

◆ GetState()

int EDA_ITEM::GetState ( int type ) const

inlineinherited

Definition at line 240 of file base_struct.h.

     {
         return m_Status & type;
     }

References EDA_ITEM::m_Status.

Referenced by BOARD::chainMarkedSegments(), PCB_EDIT_FRAME::createPopupMenuForTracks(), DRAG_SEGM_PICKER::DRAG_SEGM_PICKER(), SCH_JUNCTION::Draw(), SCH_BUS_ENTRY_BASE::Draw(), SCH_LINE::Draw(), SCH_TEXT::Draw(), KIGFX::SCH_PAINTER::draw(), TRACK::Draw(), SCH_GLOBALLABEL::Draw(), SCH_HIERLABEL::Draw(), SEGZONE::Draw(), ZONE_CONTAINER::DrawFilledArea(), PCB_BASE_EDIT_FRAME::duplicateItem(), PCB_EDIT_FRAME::EraseRedundantTrack(), SELECTION_TOOL::expandSelectedConnection(), SCH_EDIT_FRAME::GeneralControl(), LIB_EDIT_FRAME::GeneralControl(), PCB_EDIT_FRAME::GeneralControl(), TRACK::GetEndSegments(), TRACK::GetMsgPanelInfoBase_Common(), TRACK::GetTrack(), PCB_EDIT_FRAME::HandleBlockEnd(), TRACK::IsLocked(), BOARD::MarkTrace(), TRACKS_CLEANER::mergeCollinearSegmentIfPossible(), LIB_EDIT_FRAME::OnHotKey(), PCB_EDIT_FRAME::OnHotkeyFlipItem(), and PCB_EDIT_FRAME::OnHotkeyRotateItem().

◆ GetStatus()

STATUS_FLAGS EDA_ITEM::GetStatus ( ) const

inlineinherited

Definition at line 253 of file base_struct.h.

253 { return m_Status; }

EDA_ITEM::m_Status

STATUS_FLAGS m_Status

Definition: base_struct.h:164

References EDA_ITEM::m_Status.

Referenced by PCB_IO::format().

◆ GetTimeStamp()

timestamp_t EDA_ITEM::GetTimeStamp ( ) const

inlineinherited

Definition at line 207 of file base_struct.h.

207 { return m_TimeStamp; }

EDA_ITEM::m_TimeStamp

timestamp_t m_TimeStamp

Time stamp used for logical links.

Definition: base_struct.h:172

References EDA_ITEM::m_TimeStamp.

Referenced by FIELDS_EDITOR_GRID_DATA_MODEL::AddColumn(), SCH_COMPONENT::AddSheetPathReferenceEntryIfMissing(), SCH_EDIT_FRAME::AnnotateComponents(), FIELDS_EDITOR_GRID_DATA_MODEL::ApplyData(), PCB_EDIT_FRAME::Delete_OldZone_Fill(), PCB_EDIT_FRAME::Delete_Zone_Contour(), DuplicateStruct(), DIALOG_FOOTPRINT_BOARD_EDITOR::EditFootprint(), EDIT_TOOL::editFootprintInFpEditor(), SCH_EDIT_FRAME::EditSheet(), PCB_EDIT_FRAME::Exchange_Module(), PCB_IO::format(), FormatProbeItem(), NETLIST_OBJECT::GetShortNetName(), FIELDS_EDITOR_GRID_DATA_MODEL::groupMatch(), FOOTPRINT_EDIT_FRAME::Load_Module_From_BOARD(), NETLIST_EXPORTER_GENERIC::makeComponents(), mapExistingAnnotation(), FOOTPRINT_EDIT_FRAME::OnUpdateInsertModuleInBoard(), SCH_SHEET_PATH::Path(), PCB_BASE_FRAME::PcbGeneralLocateAndDisplay(), SCH_SCREENS::ReplaceDuplicateTimeStamps(), SCH_LEGACY_PLUGIN::saveComponent(), FOOTPRINT_EDIT_FRAME::SaveFootprintToBoard(), SCH_LEGACY_PLUGIN::saveSheet(), SCH_REFERENCE::SCH_REFERENCE(), ZONE_FILLER_TOOL::SegzoneDeleteFill(), SortByTimeStamp(), SwapItemData(), DIALOG_SCH_SHEET_PROPS::TransferDataToWindow(), DIALOG_EDIT_COMPONENT_IN_SCHEMATIC::TransferDataToWindow(), DIALOG_GLOBAL_EDIT_TRACKS_AND_VIAS::TransferDataToWindow(), and DIALOG_GLOBAL_EDIT_TRACKS_AND_VIAS::~DIALOG_GLOBAL_EDIT_TRACKS_AND_VIAS().

◆ GetWidth()

int PCB_TARGET::GetWidth ( ) const

inline

Definition at line 76 of file class_pcb_target.h.

76 { return m_Width; }

PCB_TARGET::m_Width

int m_Width

Definition: class_pcb_target.h:45

References m_Width.

Referenced by AbortMoveAndEditTarget(), KIGFX::PCB_PAINTER::draw(), PCB_IO::format(), PCB_EDITOR_CONTROL::PlaceTarget(), BRDITEMS_PLOTTER::PlotPcbTarget(), and DIALOG_TARGET_PROPERTIES::TransferDataToWindow().

◆ HitTest() [1/2]

bool PCB_TARGET::HitTest ( const wxPoint & aPosition ) const

overridevirtual

Function HitTest tests if aPosition is contained within or on the bounding area of an item.

Parameters

aPosition A reference to a wxPoint object containing the coordinates to test.

Returns: True if aPosition is within or on the item bounding area.

Reimplemented from BOARD_ITEM.

Definition at line 140 of file class_pcb_target.cpp.

 {
     int dX = aPosition.x - m_Pos.x;
     int dY = aPosition.y - m_Pos.y;
     int radius = m_Size / 2;
     return abs( dX ) <= radius && abs( dY ) <= radius;
 }

References abs, m_Pos, and m_Size.

◆ HitTest() [2/2]

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

overridevirtual

Parameters

aRect	A reference to an EDA_RECT object containg the area to test.
aContained	Test if aRect contains this object completly.
aAccuracy	Increase the item bounding box by this amount.

Returns: bool - True if aRect contains this object completly or if aRect intersects the object and aContained is False, otherwise false.

Reimplemented from BOARD_ITEM.

Definition at line 149 of file class_pcb_target.cpp.

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

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

◆ IsBrightened()

bool EDA_ITEM::IsBrightened ( ) const

inlineinherited

Definition at line 227 of file base_struct.h.

227 { return m_Flags & BRIGHTENED; }

BRIGHTENED

#define BRIGHTENED

item is drawn with a bright contour

Definition: base_struct.h:138

EDA_ITEM::m_Flags

STATUS_FLAGS m_Flags

Flag bits for editing and other uses.

Definition: base_struct.h:178

References BRIGHTENED, and EDA_ITEM::m_Flags.

Referenced by GERBVIEW_SELECTION_TOOL::disambiguationMenu(), KIGFX::GERBVIEW_PAINTER::draw(), and KIGFX::PCB_RENDER_SETTINGS::GetColor().

◆ IsConnected()

virtual bool BOARD_ITEM::IsConnected ( ) const

inlinevirtualinherited

Function IsConnected() Returns information if the object is derived from BOARD_CONNECTED_ITEM.

Returns: True if the object is of BOARD_CONNECTED_ITEM type, false otherwise.

Reimplemented in BOARD_CONNECTED_ITEM.

Definition at line 105 of file class_board_item.h.

     {
         return false;
     }

Referenced by CN_CONNECTIVITY_ALGO::markItemNetAsDirty(), and CONNECTIVITY_DATA::MarkItemNetAsDirty().

◆ IsDragging()

bool EDA_ITEM::IsDragging ( ) const

inlineinherited

Definition at line 222 of file base_struct.h.

222 { return m_Flags & IS_DRAGGED; }

IS_DRAGGED

#define IS_DRAGGED

Item being dragged.

Definition: base_struct.h:116

EDA_ITEM::m_Flags

STATUS_FLAGS m_Flags

Flag bits for editing and other uses.

Definition: base_struct.h:178

References IS_DRAGGED, and EDA_ITEM::m_Flags.

Referenced by Abort_Zone_Move_Corner_Or_Outlines(), Collect_TrackSegmentsToDrag(), DIALOG_EDIT_COMPONENT_IN_SCHEMATIC::DIALOG_EDIT_COMPONENT_IN_SCHEMATIC(), PCB_EDIT_FRAME::OnHotkeyPlaceItem(), PCB_EDIT_FRAME::OnLeftClick(), Show_Zone_Corner_Or_Outline_While_Move_Mouse(), and ShowClearance().

◆ IsHighlighted()

bool EDA_ITEM::IsHighlighted ( ) const

inlineinherited

Definition at line 226 of file base_struct.h.

226 { return m_Flags & HIGHLIGHTED; }

HIGHLIGHTED

#define HIGHLIGHTED

item is drawn in normal colors, when the rest is darkened

Definition: base_struct.h:137

EDA_ITEM::m_Flags

STATUS_FLAGS m_Flags

Flag bits for editing and other uses.

Definition: base_struct.h:178

References HIGHLIGHTED, and EDA_ITEM::m_Flags.

Referenced by KIGFX::SCH_PAINTER::draw(), and KIGFX::getOverlayColor().

◆ IsLocked()

virtual bool BOARD_ITEM::IsLocked ( ) const

inlinevirtualinherited

Function IsLocked.

Returns: bool - true if the object is locked, else false

Reimplemented in MODULE, and TRACK.

Definition at line 193 of file class_board_item.h.

     {
         // only MODULEs & TRACKs can be locked at this time.
         return false;
     }

Referenced by DIALOG_GLOBAL_DELETION::AcceptPcbDelete(), EditToolSelectionFilter(), GENERAL_COLLECTOR::Inspect(), and PCB_EDIT_FRAME::OnHotkeyDeleteItem().

◆ IsModified()

bool EDA_ITEM::IsModified ( ) const

inlineinherited

Definition at line 220 of file base_struct.h.

220 { return m_Flags & IS_CHANGED; }

IS_CHANGED

#define IS_CHANGED

std::function passed to nested users by ref, avoids copying std::function

Definition: base_struct.h:110

EDA_ITEM::m_Flags

STATUS_FLAGS m_Flags

Flag bits for editing and other uses.

Definition: base_struct.h:178

References IS_CHANGED, and EDA_ITEM::m_Flags.

Referenced by LIB_EDIT_FRAME::OnEditPin().

◆ IsMoving()

bool EDA_ITEM::IsMoving ( ) const

inlineinherited

Definition at line 221 of file base_struct.h.

221 { return m_Flags & IS_MOVED; }

EDA_ITEM::m_Flags

STATUS_FLAGS m_Flags

Flag bits for editing and other uses.

Definition: base_struct.h:178

IS_MOVED

#define IS_MOVED

Item being moved.

Definition: base_struct.h:113

References IS_MOVED, and EDA_ITEM::m_Flags.

Referenced by Abort_MoveOrCopyModule(), Abort_Zone_Move_Corner_Or_Outlines(), AbortMoveTextModule(), AddMenusForPin(), LIB_ARC::CalcRadiusAngles(), PCB_EDIT_FRAME::Change_Side_Module(), KIGFX::SCH_PAINTER::draw(), MODULE::Draw(), SCH_COMPONENT::Draw(), ExitSheet(), KIGFX::getOverlayColor(), SCH_EDIT_FRAME::OnOrient(), SCH_EDIT_FRAME::OnRotate(), PCB_EDIT_FRAME::Place_Texte_Pcb(), PCB_BASE_FRAME::PlaceModule(), PCB_BASE_FRAME::Rotate_Module(), Show_Zone_Corner_Or_Outline_While_Move_Mouse(), ShowClearance(), and DIALOG_TARGET_PROPERTIES::TransferDataFromWindow().

◆ IsNew()

bool EDA_ITEM::IsNew ( ) const

inlineinherited

Definition at line 219 of file base_struct.h.

219 { return m_Flags & IS_NEW; }

IS_NEW

#define IS_NEW

New item, just created.

Definition: base_struct.h:114

EDA_ITEM::m_Flags

STATUS_FLAGS m_Flags

Flag bits for editing and other uses.

Definition: base_struct.h:178

References IS_NEW, and EDA_ITEM::m_Flags.

◆ IsOnLayer()

virtual bool BOARD_ITEM::IsOnLayer ( PCB_LAYER_ID aLayer ) const

inlinevirtualinherited

Function IsOnLayer tests to see if this object is on the given layer.

Is virtual so objects like D_PAD, which reside on multiple layers can do their own form of testing.

Parameters

aLayer The layer to test for.

Returns: bool - true if on given layer, else false.

Reimplemented in D_PAD, VIA, ZONE_CONTAINER, and MARKER_PCB.

Definition at line 173 of file class_board_item.h.

     {
         return m_Layer == aLayer;
     }

References BOARD_ITEM::m_Layer.

Referenced by CINFO3D_VISU::createLayers(), TEXTE_PCB::Draw(), EDGE_MODULE::Draw(), TEXTE_MODULE::Draw(), TRACK::Draw(), DRAWSEGMENT::Draw(), SEGZONE::Draw(), TRACK::DrawShortNetname(), GENERAL_COLLECTOR::Inspect(), ZONE_CONTAINER::IsOnLayer(), AR_MATRIX::TraceSegmentPcb(), and TraceSegmentPcb().

◆ IsReplaceable()

virtual bool EDA_ITEM::IsReplaceable ( ) const

inlinevirtualinherited

Function IsReplaceable.

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

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

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

Definition at line 464 of file base_struct.h.

464 { return false; }

Referenced by EDA_ITEM::Matches(), and EDA_ITEM::Replace().

◆ IsResized()

bool EDA_ITEM::IsResized ( ) const

inlineinherited

Definition at line 225 of file base_struct.h.

225 { return m_Flags & IS_RESIZED; }

EDA_ITEM::m_Flags

STATUS_FLAGS m_Flags

Flag bits for editing and other uses.

Definition: base_struct.h:178

IS_RESIZED

#define IS_RESIZED

Item being resized.

Definition: base_struct.h:115

References IS_RESIZED, and EDA_ITEM::m_Flags.

Referenced by ExitSheet().

◆ IsSelected()

bool EDA_ITEM::IsSelected ( ) const

inlineinherited

Definition at line 224 of file base_struct.h.

224 { return m_Flags & SELECTED; }

SELECTED

#define SELECTED

Definition: base_struct.h:121

EDA_ITEM::m_Flags

STATUS_FLAGS m_Flags

Flag bits for editing and other uses.

Definition: base_struct.h:178

References EDA_ITEM::m_Flags, and SELECTED.

◆ IsTrack()

bool BOARD_ITEM::IsTrack ( ) const

inlineinherited

Function IsTrack tests to see if this object is a track or via (or microvia).

form of testing.

Returns: bool - true if a track or via, else false.

Definition at line 184 of file class_board_item.h.

     {
         return ( Type() == PCB_TRACE_T ) || ( Type() == PCB_VIA_T );
     }

References PCB_TRACE_T, PCB_VIA_T, and EDA_ITEM::Type().

Referenced by PCB_EDIT_FRAME::OnHotKey(), and PCB_EDIT_FRAME::OnHotkeyDeleteItem().

◆ IsType()

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

inlineinherited

Function IsType Checks whether the item is one of the listed types.

Parameters

aScanTypes List of item types

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

Definition at line 266 of file base_struct.h.

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

References EOT, and EDA_ITEM::m_StructType.

◆ IsWireImage()

bool EDA_ITEM::IsWireImage ( ) const

inlineinherited

Definition at line 223 of file base_struct.h.

223 { return m_Flags & IS_WIRE_IMAGE; }

IS_WIRE_IMAGE

#define IS_WIRE_IMAGE

Item to be drawn as wireframe while editing.

Definition: base_struct.h:118

EDA_ITEM::m_Flags

STATUS_FLAGS m_Flags

Flag bits for editing and other uses.

Definition: base_struct.h:178

References IS_WIRE_IMAGE, and EDA_ITEM::m_Flags.

Referenced by SCH_FIELD::Draw().

◆ IterateForward()

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

staticinherited

Function IterateForward walks through the object tree calling the inspector() on each object type requested in scanTypes.

Parameters

listStart	The first in a list of EDA_ITEMs to iterate over.
inspector	Is an INSPECTOR to call on each object that is one of the requested scanTypes.
testData	Is an aid to testFunc, and should be sufficient to allow it to fully determine if an item meets the match criteria, but it may also be used to collect output.
scanTypes	A KICAD_T array that is EOT terminated, and provides both the order and interest level of of the types of objects to be iterated over.

Returns: SEARCH_RESULT SEARCH_QUIT if the called INSPECTOR returned SEARCH_QUIT, else SCAN_CONTINUE;

Definition at line 130 of file base_struct.cpp.

 {
     EDA_ITEM* p = listStart;
 
     for( ; p; p = p->Pnext )
     {
         if( SEARCH_QUIT == p->Visit( inspector, testData, scanTypes ) )
             return SEARCH_QUIT;
     }
 
     return SEARCH_CONTINUE;
 }

References EDA_ITEM::Pnext, SEARCH_CONTINUE, SEARCH_QUIT, and EDA_ITEM::Visit().

Referenced by SCH_COLLECTOR::Collect(), SCH_FIND_COLLECTOR::Collect(), SCH_TYPE_COLLECTOR::Collect(), SCH_FIND_COLLECTOR::GetItem(), GERBER_FILE_IMAGE::Visit(), MODULE::Visit(), and BOARD::Visit().

◆ Matches() [1/2]

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

inlinevirtualinherited

Function Matches compares the item against the search criteria in aSearchData.

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

Parameters

aSearchData	A reference to a wxFindReplaceData object containing the search criteria.
aAuxData	A pointer to optional data required for the search or NULL if not used.
aFindLocation	A pointer to a wxPoint object to store the location of matched item. The pointer can be NULL if it is not used.

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

Reimplemented in SCH_COMPONENT, SCH_SHEET, SCH_SHEET_PIN, SCH_FIELD, SCH_TEXT, LIB_PIN, and SCH_MARKER.

Definition at line 420 of file base_struct.h.

     {
         return false;
     }

Referenced by SCH_FIND_COLLECTOR::Inspect(), SCH_MARKER::Matches(), LIB_PIN::Matches(), SCH_TEXT::Matches(), SCH_FIELD::Matches(), SCH_SHEET_PIN::Matches(), and SCH_SHEET::Matches().

◆ Matches() [2/2]

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

protectedinherited

Function Matches compares aText against search criteria in aSearchData.

This is a helper function for simplify derived class logic.

Parameters

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

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

Definition at line 182 of file base_struct.cpp.

 {
     wxString text = aText;
     wxString searchText = aSearchData.GetFindString();
 
     // Don't match if searching for replaceable item and the item doesn't support text replace.
     if( (aSearchData.GetFlags() & FR_SEARCH_REPLACE) && !IsReplaceable() )
         return false;
 
     if( aSearchData.GetFlags() & wxFR_WHOLEWORD )
         return aText.IsSameAs( searchText, aSearchData.GetFlags() & wxFR_MATCHCASE );
 
     if( aSearchData.GetFlags() & FR_MATCH_WILDCARD )
     {
         if( aSearchData.GetFlags() & wxFR_MATCHCASE )
             return text.Matches( searchText );
 
         return text.MakeUpper().Matches( searchText.MakeUpper() );
     }
 
     if( aSearchData.GetFlags() & wxFR_MATCHCASE )
         return aText.Find( searchText ) != wxNOT_FOUND;
 
     return text.MakeUpper().Find( searchText.MakeUpper() ) != wxNOT_FOUND;
 }

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

◆ Move() [1/2]

void PCB_TARGET::Move ( const wxPoint & aMoveVector )

inlineoverridevirtual

Function Move move this object.

Parameters

aMoveVector - the move vector for this object.

Reimplemented from BOARD_ITEM.

Definition at line 78 of file class_pcb_target.h.

     {
         m_Pos += aMoveVector;
     }

References m_Pos.

◆ Move() [2/2]

void BOARD_ITEM::Move ( const VECTOR2I & aMoveVector )

inlineinherited

Definition at line 239 of file class_board_item.h.

     {
         Move( wxPoint( aMoveVector.x, aMoveVector.y ) );
     }

References BOARD_ITEM::Move(), VECTOR2< T >::x, and VECTOR2< T >::y.

◆ Next()

BOARD_ITEM* BOARD_ITEM::Next ( ) const

inlineinherited

Definition at line 115 of file class_board_item.h.

115 { return static_cast<BOARD_ITEM*>( Pnext ); }

EDA_ITEM::Pnext

EDA_ITEM * Pnext

next in linked list

Definition: base_struct.h:167

References EDA_ITEM::Pnext.

Referenced by DIALOG_GLOBAL_DELETION::AcceptPcbDelete(), PCB_EDIT_FRAME::AppendBoardFile(), PCB_EDIT_FRAME::ArchiveModulesOnBoard(), FOOTPRINT_EDIT_FRAME::Begin_Edge_Module(), DeleteMarkedItems(), PCB_EDIT_FRAME::DoGenFootprintsReport(), PCB_EDIT_FRAME::DoShowBoardSetupDialog(), DrawMovingBlockOutlines(), PCB_EDIT_FRAME::Exchange_Module(), MODULE::GetBoundingBox(), PCB_BASE_FRAME::GetFootprintFromBoardByReference(), MODULE::GetFootprintRect(), getMatchingTextItem(), PCB_EDIT_FRAME::ImportSpecctraSession(), BRDITEMS_PLOTTER::Plot_Edges_Modules(), BRDITEMS_PLOTTER::PlotAllTextsModule(), PlotSolderMaskLayer(), PlotStandardLayer(), FOOTPRINT_EDIT_FRAME::RedrawActiveWindow(), PCB_EDIT_FRAME::Swap_Layers(), SwapItemData(), DRC::testCopperTextAndGraphics(), TestForExistingItem(), DIALOG_FOOTPRINT_FP_EDITOR::TransferDataFromWindow(), DIALOG_FOOTPRINT_FP_EDITOR::TransferDataToWindow(), and DIALOG_FOOTPRINT_BOARD_EDITOR::TransferDataToWindow().

◆ operator<()

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

inherited

Test if another item is less than this object.

Parameters

aItem - Item to compare against.

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

Definition at line 239 of file base_struct.cpp.

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

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

◆ Replace() [1/2]

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

inherited

Helper function used in search and replace dialog Function Replace performs a text replace on aText using the find and replace criteria in aSearchData on items that support text find and replace.

Parameters

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

Returns: True if aText was modified, otherwise false.

Definition at line 209 of file base_struct.cpp.

 {
     wxCHECK_MSG( IsReplaceable(), false,
                  wxT( "Attempt to replace text in <" ) + GetClass() + wxT( "> item." ) );
 
     wxString searchString = (aSearchData.GetFlags() & wxFR_MATCHCASE) ? aText : aText.Upper();
 
     int result = searchString.Find( (aSearchData.GetFlags() & wxFR_MATCHCASE) ?
                                     aSearchData.GetFindString() :
                                     aSearchData.GetFindString().Upper() );
 
     if( result == wxNOT_FOUND )
         return false;
 
     wxString prefix = aText.Left( result );
     wxString suffix;
 
     if( aSearchData.GetFindString().length() + result < aText.length() )
         suffix = aText.Right( aText.length() - ( aSearchData.GetFindString().length() + result ) );
 
     wxLogTrace( traceFindReplace, wxT( "Replacing '%s', prefix '%s', replace '%s', suffix '%s'." ),
                 GetChars( aText ), GetChars( prefix ), GetChars( aSearchData.GetReplaceString() ),
                 GetChars( suffix ) );
 
     aText = prefix + aSearchData.GetReplaceString() + suffix;
 
     return true;
 }

References GetChars(), EDA_ITEM::GetClass(), EDA_ITEM::IsReplaceable(), and traceFindReplace.

Referenced by FOOTPRINT_INFO_GENERATOR::GetHtmlFieldRow(), SCH_TEXT::Replace(), SCH_FIELD::Replace(), SCH_SHEET_PIN::Replace(), SCH_SHEET::Replace(), and SCH_FIND_COLLECTOR::ReplaceItem().

◆ Replace() [2/2]

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

inlinevirtualinherited

Function Replace performs a text replace using the find and replace criteria in aSearchData on items that support text find and replace.

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

Parameters

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

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

Reimplemented in SCH_SHEET, SCH_SHEET_PIN, SCH_FIELD, and SCH_TEXT.

Definition at line 452 of file base_struct.h.

452 { return false; }

◆ Rotate() [1/2]

void PCB_TARGET::Rotate	(	const wxPoint &	aRotCentre,
		double	aAngle
	)

overridevirtual

Function Rotate Rotate this object.

Parameters

aRotCentre	- the rotation point.
aAngle	- the rotation angle in 0.1 degree.

Reimplemented from BOARD_ITEM.

Definition at line 161 of file class_pcb_target.cpp.

 {
     RotatePoint( &m_Pos, aRotCentre, aAngle );
 }

References m_Pos, and RotatePoint().

◆ Rotate() [2/2]

void BOARD_ITEM::Rotate	(	const VECTOR2I &	aRotCentre,
		double	aAngle
	)

inlineinherited

Definition at line 255 of file class_board_item.h.

     {
         Rotate( wxPoint( aRotCentre.x, aRotCentre.y ), aAngle );
     }

References BOARD_ITEM::Rotate(), VECTOR2< T >::x, and VECTOR2< T >::y.

◆ SetBack()

void EDA_ITEM::SetBack ( EDA_ITEM * aBack )

inlineinherited

Definition at line 215 of file base_struct.h.

215 { Pback = aBack; }

EDA_ITEM::Pback

EDA_ITEM * Pback

previous in linked list

Definition: base_struct.h:168

References EDA_ITEM::Pback.

Referenced by DHEAD::append(), DHEAD::insert(), SCH_EDIT_FRAME::PutDataInPreviousState(), DHEAD::remove(), and SwapItemData().

◆ SetBrightened()

void EDA_ITEM::SetBrightened ( )

inlineinherited

Definition at line 232 of file base_struct.h.

232 { SetFlags( BRIGHTENED ); }

EDA_ITEM::SetFlags

void SetFlags(STATUS_FLAGS aMask)

Definition: base_struct.h:256

BRIGHTENED

#define BRIGHTENED

item is drawn with a bright contour

Definition: base_struct.h:138

References BRIGHTENED, and EDA_ITEM::SetFlags().

Referenced by GERBVIEW_SELECTION_TOOL::disambiguationMenu(), and SELECTION_TOOL::highlight().

◆ SetFlags()

void EDA_ITEM::SetFlags ( STATUS_FLAGS aMask )

inlineinherited

Definition at line 256 of file base_struct.h.

256 { m_Flags |= aMask; }

EDA_ITEM::m_Flags

STATUS_FLAGS m_Flags

Flag bits for editing and other uses.

Definition: base_struct.h:178

References EDA_ITEM::m_Flags.

Referenced by SCH_EAGLE_PLUGIN::addBusEntries(), SCH_SCREEN::addConnectedItemsToBlock(), PCB_BASE_FRAME::AddModuleToBoard(), AddSegmentToDragList(), PCBNEW_CONTROL::AppendBoard(), PCB_EDIT_FRAME::AppendBoardFile(), PCB_EDIT_FRAME::Begin_DrawSegment(), FOOTPRINT_EDIT_FRAME::Begin_Edge_Module(), PCB_EDIT_FRAME::Begin_Route(), PCB_EDIT_FRAME::Begin_Zone(), PCB_EDIT_FRAME::BeginMoveDimensionText(), PCB_EDIT_FRAME::BeginMoveTarget(), SCH_EDIT_FRAME::BeginSegment(), LIB_EDIT_FRAME::BlockCopySelectedItems(), PCB_EDIT_FRAME::Change_Side_Module(), SCH_EDIT_FRAME::ConvertPart(), SCH_EDIT_FRAME::copyBlockItems(), CopyMarkedItems(), LIB_EDIT_FRAME::copySelectedItems(), SCH_EDIT_FRAME::CreateBusBusEntry(), SCH_EDIT_FRAME::CreateBusWireEntry(), SCH_EDIT_FRAME::CreateNewImage(), SCH_EDIT_FRAME::CreateNewText(), LIB_EDIT_FRAME::CreatePin(), SCH_EDIT_FRAME::CreateSheet(), SCH_EDIT_FRAME::CreateSheetPin(), PCB_EDIT_FRAME::CreateTarget(), PCB_EDIT_FRAME::CreateTextePcb(), FOOTPRINT_EDIT_FRAME::CreateTextModule(), SCH_EDIT_FRAME::DeleteItem(), DrawMovingBlockOutlines(), PCB_EDIT_FRAME::EditDimension(), PCB_EDIT_FRAME::FlipTextePcb(), LIB_EDIT_FRAME::GetComponentFromRedoList(), LIB_EDIT_FRAME::GetComponentFromUndoList(), SCH_SCREEN::GetConnection(), FOOTPRINT_EDIT_FRAME::HandleBlockEnd(), SCH_EDIT_FRAME::HandleBlockPlace(), KIGFX::SCH_VIEW::HighlightItem(), PCB_BASE_FRAME::Import_Pad_Settings(), SCH_EDIT_FRAME::ImportSheetPin(), InvokeDialogImportGfxBoard(), InvokeDialogImportGfxModule(), SCH_JUNCTION::IsSelectStateChanged(), SCH_NO_CONNECT::IsSelectStateChanged(), SCH_MARKER::IsSelectStateChanged(), SCH_BUS_ENTRY_BASE::IsSelectStateChanged(), SCH_BITMAP::IsSelectStateChanged(), SCH_LINE::IsSelectStateChanged(), SCH_TEXT::IsSelectStateChanged(), SCH_SHEET::IsSelectStateChanged(), SCH_COMPONENT::IsSelectStateChanged(), SCH_EDIT_FRAME::Load_Component(), SCH_SCREEN::MarkConnections(), MarkItemsInBloc(), SCH_EDIT_FRAME::OnConvertTextType(), SCH_EDIT_FRAME::OnCopySchematicItemRequest(), LIB_EDIT_FRAME::OnEditPin(), SCH_EDIT_FRAME::OnSelectUnit(), KIGFX::ORIGIN_VIEWITEM::ORIGIN_VIEWITEM(), PCB_EDIT_FRAME::Other_Layer_Route(), PCB_EDITOR_CONTROL::PlaceModule(), DRAWING_TOOL::PlaceText(), SCH_EDIT_FRAME::PrepareMoveItem(), LIB_EDIT_FRAME::Process_Special_Functions(), SCH_EDIT_FRAME::PutDataInPreviousState(), SCH_EDIT_FRAME::RepeatDrawItem(), LIB_EDIT_FRAME::RepeatPinItem(), SCH_EDIT_FRAME::ReSizeSheet(), PCB_BASE_FRAME::Rotate_Module(), PCB_EDIT_FRAME::Rotate_Texte_Pcb(), LIB_EDIT_FRAME::SaveCopyInUndoList(), SCH_SCREEN::SelectBlockItems(), EDA_ITEM::SetBrightened(), LIB_PIN::SetConversion(), BLOCK_SELECTOR::SetFlags(), EDA_ITEM::SetHighlighted(), EDA_ITEM::SetModified(), EDA_ITEM::SetSelected(), EDA_ITEM::SetWireImage(), PCB_EDIT_FRAME::Start_DragTrackSegmentAndKeepSlope(), PCB_EDIT_FRAME::Start_Move_DrawItem(), FOOTPRINT_EDIT_FRAME::Start_Move_EdgeMod(), PCB_EDIT_FRAME::Start_Move_Zone_Corner(), PCB_EDIT_FRAME::Start_Move_Zone_Drag_Outline_Edge(), PCB_EDIT_FRAME::Start_Move_Zone_Outlines(), PCB_EDIT_FRAME::StartMoveModule(), PCB_EDIT_FRAME::StartMoveOneNodeOrSegment(), PCB_BASE_FRAME::StartMovePad(), LIB_EDIT_FRAME::StartMovePin(), PCB_BASE_FRAME::StartMoveTexteModule(), PCB_EDIT_FRAME::StartMoveTextePcb(), DIALOG_TEXT_PROPERTIES::TransferDataFromWindow(), DIALOG_TARGET_PROPERTIES::TransferDataFromWindow(), DIALOG_EDIT_COMPONENT_IN_SCHEMATIC::TransferDataFromWindow(), DIALOG_PAD_PROPERTIES::TransferDataFromWindow(), and UndrawAndMarkSegmentsToDrag().

◆ SetForceVisible()

void EDA_ITEM::SetForceVisible ( bool aEnable )

inlineinherited

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

Parameters

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

Definition at line 285 of file base_struct.h.

285 { m_forceVisible = aEnable; }

EDA_ITEM::m_forceVisible

bool m_forceVisible

Set to true to override the visibility setting of the item.

Definition: base_struct.h:175

References EDA_ITEM::m_forceVisible.

Referenced by SCH_EDIT_FRAME::OnFindSchematicItem(), and SCH_EDIT_FRAME::updateFindReplaceView().

◆ SetHighlighted()

void EDA_ITEM::SetHighlighted ( )

inlineinherited

Definition at line 231 of file base_struct.h.

231 { SetFlags( HIGHLIGHTED ); }

EDA_ITEM::SetFlags

void SetFlags(STATUS_FLAGS aMask)

Definition: base_struct.h:256

HIGHLIGHTED

#define HIGHLIGHTED

item is drawn in normal colors, when the rest is darkened

Definition: base_struct.h:137

References HIGHLIGHTED, and EDA_ITEM::SetFlags().

◆ SetLayer()

virtual void BOARD_ITEM::SetLayer ( PCB_LAYER_ID aLayer )

inlinevirtualinherited

Function SetLayer sets the layer this item is on.

Parameters

aLayer The layer number. is virtual because some items (in fact: class DIMENSION) have a slightly different initialization

Reimplemented in ZONE_CONTAINER, and DIMENSION.

Definition at line 140 of file class_board_item.h.

     {
         // trap any invalid layers, then go find the caller and fix it.
         // wxASSERT( unsigned( aLayer ) < unsigned( NB_PCB_LAYERS ) );
         m_Layer = aLayer;
     }

References BOARD_ITEM::m_Layer.

◆ SetList()

void EDA_ITEM::SetList ( DHEAD * aList )

inlineinherited

Definition at line 217 of file base_struct.h.

217 { m_List = aList; }

EDA_ITEM::m_List

DHEAD * m_List

which DLIST I am on.

Definition: base_struct.h:169

References EDA_ITEM::m_List.

Referenced by DHEAD::append(), DHEAD::insert(), DHEAD::remove(), and SwapItemData().

◆ SetLocked()

virtual void BOARD_ITEM::SetLocked ( bool aLocked )

inlinevirtualinherited

Function SetLocked modifies 'lock' status for of the item.

Reimplemented in MODULE, and TRACK.

Definition at line 203 of file class_board_item.h.

     {
         // only MODULEs & TRACKs can be locked at this time.
     }

◆ SetModified()

void EDA_ITEM::SetModified ( )

inherited

Definition at line 100 of file base_struct.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 SCH_COMPONENT::ClearAnnotation(), SCH_LINE::Move(), LIB_PIN::Move(), SCH_COMPONENT::Move(), LIB_PART::RemoveDrawItem(), SCH_COMPONENT::SetConvert(), LIB_PIN::SetLength(), SCH_COMPONENT::SetLibId(), EDA_ITEM::SetModified(), LIB_FIELD::SetName(), LIB_PIN::SetName(), LIB_PIN::SetNameTextSize(), LIB_PIN::SetNumber(), LIB_PIN::SetNumberTextSize(), LIB_PIN::SetOrientation(), LIB_PIN::SetPartNumber(), LIB_PIN::SetPinPosition(), LIB_PIN::SetShape(), SCH_COMPONENT::SetTransform(), LIB_PIN::SetType(), SCH_COMPONENT::SetUnit(), LIB_PIN::SetVisible(), and LIB_PIN::SetWidth().

◆ SetNext()

void EDA_ITEM::SetNext ( EDA_ITEM * aNext )

inlineinherited

Definition at line 214 of file base_struct.h.

214 { Pnext = aNext; }

EDA_ITEM::Pnext

EDA_ITEM * Pnext

next in linked list

Definition: base_struct.h:167

References EDA_ITEM::Pnext.

Referenced by DHEAD::append(), DHEAD::insert(), SCH_EDIT_FRAME::PutDataInPreviousState(), DHEAD::remove(), and SwapItemData().

◆ SetParent()

void EDA_ITEM::SetParent ( EDA_ITEM * aParent )

inlineinherited

Definition at line 216 of file base_struct.h.

216 { m_Parent = aParent; }

EDA_ITEM::m_Parent

EDA_ITEM * m_Parent

Linked list: Link (parent struct)

Definition: base_struct.h:171

References EDA_ITEM::m_Parent.

Referenced by MODULE::Add(), BOARD::Add(), BOARD_NETLIST_UPDATER::addNewComponent(), LIB_FIELD::Copy(), SCH_EDIT_FRAME::copyBlockItems(), CopyMarkedItems(), SCH_EDIT_FRAME::CreateSheet(), DIALOG_LIB_EDIT_PIN::DIALOG_LIB_EDIT_PIN(), PCB_EDIT_FRAME::Exchange_Module(), PCB_IO::FootprintSave(), DISPLAY_FOOTPRINTS_FRAME::Get_Module(), LIB_PART::LIB_PART(), FOOTPRINT_EDIT_FRAME::Load_Module_From_BOARD(), SCH_LEGACY_PLUGIN::loadHierarchy(), LIB_EDIT_FRAME::LoadOneSymbol(), MODULE::MODULE(), DIALOG_LIB_EDIT_PIN::OnPaintShowPanel(), MODULE::operator=(), SCH_COMPONENT::operator=(), PCB_PARSER::parseMODULE_unchecked(), LIB_EDIT_FRAME::pasteClipboard(), PCBNEW_CONTROL::PasteItemsFromClipboard(), BOARD_COMMIT::Push(), FOOTPRINT_PREVIEW_PANEL::renderFootprint(), BOARD::ReplaceNetlist(), PCB_BASE_EDIT_FRAME::SaveCopyInUndoList(), SaveCopyOfZones(), FOOTPRINT_EDIT_FRAME::SaveFootprintToBoard(), SCH_COMPONENT::SCH_COMPONENT(), SCH_SHEET::SCH_SHEET(), SCH_SHEET_PIN::SCH_SHEET_PIN(), LIB_PART::SetFields(), SetSchItemParent(), PCB_EDIT_FRAME::StartMoveModule(), SCH_SHEET::SwapData(), SCH_COMPONENT::SwapData(), SwapItemData(), and DIALOG_EDIT_COMPONENT_IN_SCHEMATIC::UpdateFieldsFromLibrary().

◆ SetPosition()

void PCB_TARGET::SetPosition ( const wxPoint & aPos )

inlineoverridevirtual

Implements BOARD_ITEM.

Definition at line 66 of file class_pcb_target.h.

66 { m_Pos = aPos; }

PCB_TARGET::m_Pos

wxPoint m_Pos

Definition: class_pcb_target.h:46

References m_Pos.

Referenced by AbortMoveAndEditTarget(), PCB_EDIT_FRAME::CreateTarget(), PCB_EDITOR_CONTROL::PlaceTarget(), and ShowTargetShapeWhileMovingMouse().

◆ SetSelected()

void EDA_ITEM::SetSelected ( )

inlineinherited

Definition at line 230 of file base_struct.h.

230 { SetFlags( SELECTED ); }

SELECTED

#define SELECTED

Definition: base_struct.h:121

EDA_ITEM::SetFlags

void SetFlags(STATUS_FLAGS aMask)

Definition: base_struct.h:256

References SELECTED, and EDA_ITEM::SetFlags().

Referenced by SELECTION_TOOL::highlight(), LIB_EDIT_FRAME::pasteClipboard(), and GERBVIEW_SELECTION_TOOL::selectVisually().

◆ SetShape()

void PCB_TARGET::SetShape ( int aShape )

inline

Definition at line 69 of file class_pcb_target.h.

69 { m_Shape = aShape; }

PCB_TARGET::m_Shape

int m_Shape

Definition: class_pcb_target.h:43

References m_Shape.

Referenced by AbortMoveAndEditTarget(), and DIALOG_TARGET_PROPERTIES::TransferDataFromWindow().

◆ SetSize()

void PCB_TARGET::SetSize ( int aSize )

inline

Definition at line 72 of file class_pcb_target.h.

72 { m_Size = aSize; }

PCB_TARGET::m_Size

int m_Size

Definition: class_pcb_target.h:44

References m_Size.

Referenced by AbortMoveAndEditTarget(), PCB_EDIT_FRAME::CreateTarget(), PCB_EDITOR_CONTROL::PlaceTarget(), and DIALOG_TARGET_PROPERTIES::TransferDataFromWindow().

◆ SetState()

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

inlineinherited

Definition at line 245 of file base_struct.h.

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

References EDA_ITEM::m_Status.

◆ SetStatus()

void EDA_ITEM::SetStatus ( STATUS_FLAGS aStatus )

inlineinherited

Definition at line 254 of file base_struct.h.

254 { m_Status = aStatus; }

EDA_ITEM::m_Status

STATUS_FLAGS m_Status

Definition: base_struct.h:164

References EDA_ITEM::m_Status.

Referenced by DeleteNullTrackSegments(), PCB_EDIT_FRAME::Start_DragTrackSegmentAndKeepSlope(), PCB_EDIT_FRAME::StartMoveOneNodeOrSegment(), and BOARD_NETLIST_UPDATER::UpdateNetlist().

◆ SetTimeStamp()

void EDA_ITEM::SetTimeStamp ( timestamp_t aNewTimeStamp )

inlineinherited

Definition at line 206 of file base_struct.h.

206 { m_TimeStamp = aNewTimeStamp; }

EDA_ITEM::m_TimeStamp

timestamp_t m_TimeStamp

Time stamp used for logical links.

Definition: base_struct.h:172

References EDA_ITEM::m_TimeStamp.

Referenced by PCB_BASE_FRAME::AddModuleToBoard(), BOARD_NETLIST_UPDATER::addNewComponent(), PCAD2KICAD::PCB_TEXT::AddToBoard(), PCAD2KICAD::PCB_LINE::AddToBoard(), PCAD2KICAD::PCB_ARC::AddToBoard(), PCAD2KICAD::PCB_PAD::AddToBoard(), PCAD2KICAD::PCB_POLYGON::AddToBoard(), PCAD2KICAD::PCB_MODULE::AddToBoard(), SCH_EDIT_FRAME::AppendSchematic(), PCB_EDIT_FRAME::Begin_Zone(), SCH_EDIT_FRAME::CreateSheet(), Diagnose(), SCH_EDIT_FRAME::DuplicateItemsInList(), DuplicateStruct(), DIALOG_FOOTPRINT_BOARD_EDITOR::EditFootprint(), EDIT_TOOL::editFootprintInFpEditor(), PCB_EDIT_FRAME::Exchange_Module(), PCB_IO::FootprintSave(), EDA_ITEM::initVars(), BOARD::InsertArea(), LEGACY_PLUGIN::loadMODULE(), LEGACY_PLUGIN::loadPCB_TARGET(), LEGACY_PLUGIN::loadPCB_TEXT(), EAGLE_PLUGIN::loadPlain(), EAGLE_PLUGIN::loadPolygon(), EAGLE_PLUGIN::loadSignals(), LEGACY_PLUGIN::loadTrackList(), EDA_ITEM::operator=(), EAGLE_PLUGIN::packageCircle(), EAGLE_PLUGIN::packagePolygon(), EAGLE_PLUGIN::packageRectangle(), EAGLE_PLUGIN::packageText(), PCB_PARSER::parseDIMENSION(), SCH_EDIT_FRAME::PasteListOfItems(), PCB_EDITOR_CONTROL::PlaceModule(), PCB_EDIT_FRAME::Process_Special_Functions(), SCH_SCREENS::ReplaceDuplicateTimeStamps(), BOARD::ReplaceNetlist(), FOOTPRINT_EDIT_FRAME::SaveFootprintToBoard(), SCH_SHEET::SCH_SHEET(), SCH_COMPONENT::SetTimeStamp(), SimilarLabelsDiagnose(), SwapItemData(), TestDuplicateSheetNames(), and DIALOG_ERC::TestErc().

◆ SetWidth()

void PCB_TARGET::SetWidth ( int aWidth )

inline

Definition at line 75 of file class_pcb_target.h.

75 { m_Width = aWidth; }

PCB_TARGET::m_Width

int m_Width

Definition: class_pcb_target.h:45

References m_Width.

Referenced by AbortMoveAndEditTarget(), PCB_EDIT_FRAME::CreateTarget(), PCB_EDITOR_CONTROL::PlaceTarget(), and DIALOG_TARGET_PROPERTIES::TransferDataFromWindow().

◆ SetWireImage()

void EDA_ITEM::SetWireImage ( )

inlineinherited

Definition at line 229 of file base_struct.h.

229 { SetFlags( IS_WIRE_IMAGE ); }

EDA_ITEM::SetFlags

void SetFlags(STATUS_FLAGS aMask)

Definition: base_struct.h:256

IS_WIRE_IMAGE

#define IS_WIRE_IMAGE

Item to be drawn as wireframe while editing.

Definition: base_struct.h:118

References IS_WIRE_IMAGE, and EDA_ITEM::SetFlags().

◆ ShowShape()

wxString BOARD_ITEM::ShowShape ( STROKE_T aShape )

staticinherited

Function ShowShape converts the enum STROKE_T integer value to a wxString.

Definition at line 39 of file class_board_item.cpp.

 {
     switch( aShape )
     {
     case S_SEGMENT:         return _( "Line" );
     case S_RECT:            return _( "Rect" );
     case S_ARC:             return _( "Arc" );
     case S_CIRCLE:          return _( "Circle" );
     case S_CURVE:           return _( "Bezier Curve" );
     case S_POLYGON:         return _( "Polygon" );
     default:                return wxT( "??" );
     }
 }

References S_ARC, S_CIRCLE, S_CURVE, S_POLYGON, S_RECT, and S_SEGMENT.

Referenced by ConvertOutlineToPolygon(), DRAWSEGMENT::GetCenter(), EDGE_MODULE::GetSelectMenuText(), DRAWSEGMENT::GetSelectMenuText(), DSN::SPECCTRA_DB::makeIMAGE(), and DRAWSEGMENT::Rotate().

◆ Sort()

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

inlinestaticinherited

Function Sort is a helper function to be used by the C++ STL sort algorithm for sorting a STL container of EDA_ITEM pointers.

Parameters

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

Returns: True if aLeft is less than aRight.

Definition at line 483 of file base_struct.h.

483 { return *aLeft < *aRight; }

Referenced by PART_LIB::GetEntryTypePowerNames().

◆ SwapData()

void PCB_TARGET::SwapData ( BOARD_ITEM * aImage )

overridevirtual

Swap data between aItem and aImage.

aItem and aImage should have the same type Used in undo redo command to swap values between an item and its copy Only values like layer, size .. which are modified by editing are swapped, not the pointers like Pnext and Pback because aItem is not changed in the linked list

Parameters

aImage = the item image which contains data to swap

Reimplemented from BOARD_ITEM.

Definition at line 203 of file class_pcb_target.cpp.

 {
     assert( aImage->Type() == PCB_TARGET_T );
 
     std::swap( *((PCB_TARGET*) this), *((PCB_TARGET*) aImage) );
 }

References PCB_TARGET_T, and EDA_ITEM::Type().

Referenced by PCB_EDIT_FRAME::PlaceTarget().

◆ TransformShapeWithClearanceToPolygon()

void BOARD_ITEM::TransformShapeWithClearanceToPolygon	(	SHAPE_POLY_SET &	aCornerBuffer,
		int	aClearanceValue,
		int	aCircleToSegmentsCount,
		double	aCorrectionFactor,
		bool	ignoreLineWidth = `false`
	)		const

virtualinherited

Function TransformShapeWithClearanceToPolygon Convert the item shape to a closed polygon Used in filling zones calculations Circles and arcs are approximated by segments.

Parameters

aCornerBuffer	= a buffer to store the polygon
aClearanceValue	= the clearance around the pad
aCircleToSegmentsCount	= the number of segments to approximate a circle
aCorrectionFactor	= the correction to apply to circles radius to keep clearance when the circle is approximated by segment bigger or equal to the real clearance value (usually near from 1.0)
ignoreLineWidth	= used for edge cut items where the line width is only for visualization

Reimplemented in D_PAD, ZONE_CONTAINER, DRAWSEGMENT, and TRACK.

Definition at line 143 of file class_board_item.cpp.

 {
     wxASSERT_MSG( false, "Called TransformShapeWithClearanceToPolygon() on unsupported BOARD_ITEM." );
 };

◆ Type()

KICAD_T EDA_ITEM::Type ( ) const

inlineinherited

Function Type()

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

Returns: KICAD_T - the type of object.

Definition at line 201 of file base_struct.h.

     {
         return m_StructType;
     }

References EDA_ITEM::m_StructType.

◆ UnLink()

void BOARD_ITEM::UnLink ( )

virtualinherited

Function UnLink detaches this object from its owner.

This base class implementation should work for all derived classes which are held in a DLIST<>.

Definition at line 54 of file class_board_item.cpp.

 {
     DLIST<BOARD_ITEM>* list = (DLIST<BOARD_ITEM>*) GetList();
     wxASSERT( list );
 
     if( list )
         list->Remove( this );
 }

References EDA_ITEM::GetList(), and DLIST< T >::Remove().

Referenced by PCB_EDIT_FRAME::Block_Delete(), PCB_EDIT_FRAME::Delete_Segment_Edge(), PCB_EDIT_FRAME::Delete_Texte_Pcb(), PCB_EDIT_FRAME::DeleteDimension(), PCB_EDIT_FRAME::DeleteTarget(), and PCB_EDIT_FRAME::EraseRedundantTrack().

◆ ViewBBox()

const BOX2I EDA_ITEM::ViewBBox ( ) const

overridevirtualinherited

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

Returns: BOX2I - the current bounding box

Implements KIGFX::VIEW_ITEM.

Reimplemented in D_PAD, MODULE, EDIT_POINTS, GERBER_DRAW_ITEM, TRACK, DRAWSEGMENT, DIMENSION, TEXTE_MODULE, KIGFX::WORKSHEET_VIEWITEM, MARKER_PCB, ROUTER_PREVIEW_ITEM, KIGFX::PREVIEW::CENTRELINE_RECT_ITEM, KIGFX::ORIGIN_VIEWITEM, KIGFX::PREVIEW::POLYGON_ITEM, KIGFX::PREVIEW::SELECTION_AREA, KIGFX::PREVIEW::RULER_ITEM, KIGFX::RATSNEST_VIEWITEM, BRIGHT_BOX, and KIGFX::PREVIEW::ARC_ASSISTANT.

Definition at line 265 of file base_struct.cpp.

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

References EDA_ITEM::GetBoundingBox().

Referenced by BRIGHT_BOX::ViewBBox(), DIMENSION::ViewBBox(), DRAWSEGMENT::ViewBBox(), BRIGHT_BOX::ViewDraw(), and COMMON_TOOLS::ZoomFitScreen().

◆ ViewDraw()

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

inlinevirtualinherited

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

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

Parameters

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

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

Definition at line 116 of file view_item.h.

117 {}

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

◆ ViewGetLayers()

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

overridevirtualinherited

Function ViewGetLayers() Returns the all the layers within the VIEW the object is painted on.

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

Parameters

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

Reimplemented from EDA_ITEM.

Reimplemented in D_PAD, MODULE, VIA, TRACK, TEXTE_MODULE, ZONE_CONTAINER, MARKER_PCB, and KIGFX::ORIGIN_VIEWITEM.

Definition at line 90 of file class_board_item.cpp.

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

References BOARD_ITEM::m_Layer.

Referenced by SELECTION_TOOL::selectable().

◆ ViewGetLOD()

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

inlinevirtualinherited

Function ViewGetLOD() Returns the level of detail (LOD) of the item.

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

Parameters

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

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

Reimplemented in D_PAD, MODULE, VIA, GERBER_DRAW_ITEM, TRACK, TEXTE_MODULE, and EDGE_MODULE.

Definition at line 140 of file view_item.h.

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

Referenced by KIGFX::VIEW::drawItem::operator()().

◆ viewPrivData()

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

inlineinherited

Definition at line 148 of file view_item.h.

     {
         return m_viewPrivData;
     }

References KIGFX::VIEW_ITEM::m_viewPrivData.

Referenced by KIGFX::VIEW::Add(), KIGFX::VIEW::drawItem::deferredDraw(), KIGFX::VIEW::draw(), KIGFX::VIEW::Hide(), KIGFX::VIEW::invalidateItem(), KIGFX::VIEW::IsVisible(), KIGFX::VIEW::OnDestroy(), KIGFX::queryVisitor< Container >::operator()(), KIGFX::VIEW::updateItemsColor::operator()(), KIGFX::VIEW::changeItemsDepth::operator()(), KIGFX::VIEW::drawItem::operator()(), KIGFX::VIEW::recacheItem::operator()(), KIGFX::VIEW::clearLayerCache::operator()(), KIGFX::VIEW::Remove(), KIGFX::VIEW::SetVisible(), KIGFX::VIEW::Update(), KIGFX::VIEW::updateItemColor(), KIGFX::VIEW::updateItemGeometry(), and KIGFX::VIEW::updateLayers().

◆ Visit()

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

virtualinherited

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

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

Parameters

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

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

Reimplemented in BOARD, SCH_COMPONENT, MODULE, SCH_SHEET, GERBER_FILE_IMAGE, GERBER_DRAW_ITEM, TRACK, and GBR_LAYOUT.

Definition at line 149 of file base_struct.cpp.

 {
     KICAD_T stype;
 
 #if 0 && defined(DEBUG)
     std::cout << GetClass().mb_str() << ' ';
 #endif
 
     for( const KICAD_T* p = scanTypes;  (stype = *p) != EOT;   ++p )
     {
         // If caller wants to inspect my type
         if( stype == Type() )
         {
             if( SEARCH_QUIT == inspector( this, testData ) )
                 return SEARCH_QUIT;
 
             break;
         }
     }
 
     return SEARCH_CONTINUE;
 }

References EOT, EDA_ITEM::GetClass(), SEARCH_CONTINUE, SEARCH_QUIT, and EDA_ITEM::Type().

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

Member Data Documentation

◆ m_Flags

STATUS_FLAGS EDA_ITEM::m_Flags

protectedinherited

Flag bits for editing and other uses.

Definition at line 178 of file base_struct.h.

Referenced by LIB_CIRCLE::BeginEdit(), LIB_RECTANGLE::BeginEdit(), LIB_POLYLINE::BeginEdit(), LIB_TEXT::BeginEdit(), LIB_ARC::BeginEdit(), LIB_FIELD::BeginEdit(), LIB_CIRCLE::CalcEdit(), LIB_POLYLINE::CalcEdit(), LIB_RECTANGLE::CalcEdit(), LIB_TEXT::CalcEdit(), LIB_ARC::CalcEdit(), LIB_FIELD::CalcEdit(), LIB_PIN::CalcEdit(), EDA_ITEM::ClearFlags(), LIB_TEXT::Clone(), LIB_CIRCLE::ContinueEdit(), LIB_RECTANGLE::ContinueEdit(), LIB_POLYLINE::ContinueEdit(), LIB_TEXT::ContinueEdit(), LIB_ARC::ContinueEdit(), LIB_FIELD::ContinueEdit(), SCH_LINE::Draw(), TRACK::Draw(), DRAWSEGMENT::Draw(), MODULE::Draw(), SEGZONE::Draw(), D_PAD::Draw(), LIB_CIRCLE::drawGraphic(), LIB_POLYLINE::drawGraphic(), LIB_RECTANGLE::drawGraphic(), LIB_BEZIER::drawGraphic(), LIB_ARC::drawGraphic(), DRAWSEGMENT::DRAWSEGMENT(), LIB_CIRCLE::EndEdit(), LIB_RECTANGLE::EndEdit(), LIB_POLYLINE::EndEdit(), LIB_TEXT::EndEdit(), LIB_ARC::EndEdit(), LIB_ITEM::EndEdit(), LIB_FIELD::EndEdit(), EDA_ITEM::GetFlags(), TRACK::GetMsgPanelInfoBase_Common(), SCH_JUNCTION::HitTest(), SCH_LINE::HitTest(), SCH_COMPONENT::HitTest(), LIB_ITEM::InEditMode(), EDA_ITEM::initVars(), EDA_ITEM::IsBrightened(), SCH_ITEM::IsConnected(), EDA_ITEM::IsDragging(), EDA_ITEM::IsHighlighted(), EDA_ITEM::IsModified(), EDA_ITEM::IsMoving(), EDA_ITEM::IsNew(), EDA_ITEM::IsResized(), EDA_ITEM::IsSelected(), EDA_ITEM::IsWireImage(), SCH_LINE::Move(), EDA_ITEM::operator=(), SCH_COMPONENT::SCH_COMPONENT(), LIB_PIN::SetConversion(), EDA_ITEM::SetFlags(), LIB_PIN::SetLength(), LIB_PIN::SetName(), LIB_PIN::SetNameTextSize(), LIB_PIN::SetNumberTextSize(), LIB_PIN::SetOrientation(), LIB_PIN::SetPartNumber(), LIB_PIN::SetPinPosition(), LIB_PIN::SetShape(), LIB_PIN::SetType(), and LIB_PIN::SetVisible().

◆ m_forceVisible

bool EDA_ITEM::m_forceVisible

protectedinherited

Set to true to override the visibility setting of the item.

Definition at line 175 of file base_struct.h.

Referenced by SCH_FIELD::Draw(), EDA_ITEM::initVars(), EDA_ITEM::operator=(), and EDA_ITEM::SetForceVisible().

◆ m_Layer

PCB_LAYER_ID BOARD_ITEM::m_Layer

protectedinherited

Definition at line 72 of file class_board_item.h.

Referenced by DIMENSION::DIMENSION(), TEXTE_PCB::Draw(), Draw(), EDGE_MODULE::Draw(), TEXTE_MODULE::Draw(), TRACK::Draw(), DIMENSION::Draw(), SEGZONE::Draw(), EDGE_MODULE::EDGE_MODULE(), BOARD_ITEM::GetLayer(), BOARD_ITEM::GetLayerName(), ZONE_CONTAINER::GetLayerSet(), BOARD_ITEM::GetLayerSet(), VIA::GetLayerSet(), TRACK::GetMsgPanelInfoBase(), SEGZONE::GetMsgPanelInfoBase(), BOARD_ITEM::IsOnLayer(), DRAWSEGMENT::IsPolygonFilled(), VIA::LayerPair(), MODULE::MODULE(), PCB_TARGET(), VIA::SanitizeLayers(), DIMENSION::SetLayer(), BOARD_ITEM::SetLayer(), ZONE_CONTAINER::SetLayer(), VIA::SetLayerPair(), ZONE_CONTAINER::SetLayerSet(), VIA::SetTopLayer(), VIA::TopLayer(), ZONE_CONTAINER::ViewGetLayers(), BOARD_ITEM::ViewGetLayers(), VIA::ViewGetLayers(), MODULE::ViewGetLayers(), TEXTE_MODULE::ViewGetLOD(), and MODULE::ViewGetLOD().

◆ m_List

DHEAD* EDA_ITEM::m_List

protectedinherited

which DLIST I am on.

Definition at line 169 of file base_struct.h.

Referenced by EDA_ITEM::GetList(), EDA_ITEM::initVars(), and EDA_ITEM::SetList().

◆ m_Parent

EDA_ITEM* EDA_ITEM::m_Parent

protectedinherited

Linked list: Link (parent struct)

Definition at line 171 of file base_struct.h.

Referenced by LIB_FIELD::Copy(), D_PAD::D_PAD(), EDGE_MODULE::Draw(), SCH_FIELD::Draw(), TEXTE_MODULE::Draw(), EDA_ITEM::EDA_ITEM(), SCH_FIELD::GetBoundingBox(), LIB_PIN::GetBoundingBox(), TEXTE_MODULE::GetDrawRotation(), SCH_FIELD::GetFullyQualifiedText(), TEXTE_PCB::GetMsgPanelInfo(), EDGE_MODULE::GetMsgPanelInfo(), TEXTE_MODULE::GetMsgPanelInfo(), D_PAD::GetMsgPanelInfo(), BOARD_ITEM::GetParent(), SCH_SHEET_PIN::GetParent(), D_PAD::GetParent(), EDA_ITEM::GetParent(), LIB_ITEM::GetParent(), DRAWSEGMENT::GetParentModule(), LIB_FIELD::HitTest(), EDA_ITEM::initVars(), LIB_ITEM::LIB_ITEM(), SCH_FIELD::Matches(), LIB_FIELD::operator=(), EDA_ITEM::operator=(), SCH_FIELD::Replace(), SCH_COMPONENT::SCH_COMPONENT(), EDGE_MODULE::SetDrawCoord(), TEXTE_MODULE::SetDrawCoord(), D_PAD::SetDrawCoord(), EDGE_MODULE::SetLocalCoord(), TEXTE_MODULE::SetLocalCoord(), D_PAD::SetLocalCoord(), EDA_ITEM::SetModified(), EDA_ITEM::SetParent(), and TEXTE_MODULE::TEXTE_MODULE().

◆ m_Pos

wxPoint PCB_TARGET::m_Pos

private

Definition at line 46 of file class_pcb_target.h.

Referenced by Draw(), Flip(), GetBoundingBox(), GetPosition(), HitTest(), Move(), PCB_TARGET(), Rotate(), and SetPosition().

◆ m_Shape

int PCB_TARGET::m_Shape

private

Definition at line 43 of file class_pcb_target.h.

Referenced by GetShape(), PCB_TARGET(), and SetShape().

◆ m_Size

int PCB_TARGET::m_Size

private

Definition at line 44 of file class_pcb_target.h.

Referenced by Draw(), GetBoundingBox(), GetSelectMenuText(), GetSize(), HitTest(), PCB_TARGET(), and SetSize().

◆ m_TimeStamp

timestamp_t EDA_ITEM::m_TimeStamp

protectedinherited

Time stamp used for logical links.

Definition at line 172 of file base_struct.h.

Referenced by SCH_SHEET::GetMsgPanelInfo(), SCH_COMPONENT::GetPath(), EDA_ITEM::GetTimeStamp(), SCH_COMPONENT::SCH_COMPONENT(), SCH_SHEET::SCH_SHEET(), EDA_ITEM::SetTimeStamp(), and SCH_COMPONENT::SetTimeStamp().

◆ m_Width

int PCB_TARGET::m_Width

private

Definition at line 45 of file class_pcb_target.h.

Referenced by Draw(), GetWidth(), PCB_TARGET(), and SetWidth().

◆ Pback

EDA_ITEM* EDA_ITEM::Pback

protectedinherited

previous in linked list

Definition at line 168 of file base_struct.h.

Referenced by SCH_LINE::Back(), TRACK::Back(), BOARD_ITEM::Back(), GERBER_DRAW_ITEM::Back(), MODULE::Back(), SCH_ITEM::Back(), EDA_ITEM::Back(), EDA_ITEM::initVars(), GERBER_DRAW_ITEM::SetBack(), EDA_ITEM::SetBack(), and TRACK::SetBack().

◆ Pnext

EDA_ITEM* EDA_ITEM::Pnext

protectedinherited

next in linked list

Definition at line 167 of file base_struct.h.

Referenced by TRACK::GetEndNetCode(), TRACK::GetStartNetCode(), EDA_ITEM::initVars(), EDA_ITEM::IterateForward(), GBR_SCREEN::Next(), PCB_SCREEN::Next(), SCH_LINE::Next(), TRACK::Next(), BOARD_ITEM::Next(), GERBER_DRAW_ITEM::Next(), MODULE::Next(), SCH_ITEM::Next(), D_PAD::Next(), EDA_ITEM::Next(), SEGZONE::Next(), GERBER_DRAW_ITEM::SetNext(), EDA_ITEM::SetNext(), and TRACK::SetNext().

◆ ZeroOffset

wxPoint BOARD_ITEM::ZeroOffset

staticinherited

A value of wxPoint(0,0) which can be passed to the Draw() functions.

Definition at line 113 of file class_board_item.h.

Referenced by BOARD::GetPosition().

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

Public Member Functions

Static Public Member Functions

Static Public Attributes

Protected Member Functions

Static Protected Member Functions

Protected Attributes

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ PCB_TARGET() [1/2]

◆ PCB_TARGET() [2/2]

◆ ~PCB_TARGET()

Member Function Documentation

◆ Back()

◆ ClassOf()

◆ ClearBrightened()

◆ ClearFlags()

◆ ClearHighlighted()

◆ ClearSelected()

◆ ClearViewPrivData()

◆ Clone()

◆ DeleteStructure()

◆ Draw()

◆ Flip() [1/2]

◆ Flip() [2/2]

◆ GetBoard()

◆ GetBoundingBox()

◆ GetCenter()

◆ GetClass()

◆ GetFlags()

◆ GetLayer()

◆ GetLayerName()

◆ GetLayerSet()

◆ GetList()

◆ GetMenuImage()

◆ GetMsgPanelInfo()

◆ getNextNumberInSequence()

◆ GetParent()

◆ GetPosition()

◆ GetSelectMenuText()

◆ GetShape()

◆ GetSize()

◆ GetState()

◆ GetStatus()

◆ GetTimeStamp()

◆ GetWidth()

◆ HitTest() [1/2]

◆ HitTest() [2/2]

◆ IsBrightened()

◆ IsConnected()

◆ IsDragging()

◆ IsHighlighted()

◆ IsLocked()

◆ IsModified()

◆ IsMoving()

◆ IsNew()

◆ IsOnLayer()

◆ IsReplaceable()

◆ IsResized()

◆ IsSelected()

◆ IsTrack()

◆ IsType()

◆ IsWireImage()

◆ IterateForward()

◆ Matches() [1/2]

◆ Matches() [2/2]

◆ Move() [1/2]

◆ Move() [2/2]

◆ Next()

◆ operator<()

◆ Replace() [1/2]

◆ Replace() [2/2]

◆ Rotate() [1/2]

◆ Rotate() [2/2]

◆ SetBack()

◆ SetBrightened()

◆ SetFlags()

◆ SetForceVisible()

◆ SetHighlighted()

◆ SetLayer()