KiCad PCB EDA Suite
VIA Class Reference

#include <class_track.h>

Inheritance diagram for VIA:
TRACK BOARD_CONNECTED_ITEM BOARD_ITEM EDA_ITEM KIGFX::VIEW_ITEM

Public Member Functions

 VIA (BOARD_ITEM *aParent)
 
void Draw (EDA_DRAW_PANEL *panel, wxDC *DC, GR_DRAWMODE aDrawMode, const wxPoint &aOffset=ZeroOffset) override
 Function Draw BOARD_ITEMs have their own color information. More...
 
bool IsOnLayer (PCB_LAYER_ID aLayer) const override
 Function IsOnLayer tests to see if this object is on the given layer. More...
 
virtual LSET GetLayerSet () const override
 Function GetLayerSet returns a "layer mask", which is a bitmap of all layers on which the TRACK segment or VIA physically resides. More...
 
void SetLayerPair (PCB_LAYER_ID aTopLayer, PCB_LAYER_ID aBottomLayer)
 Function SetLayerPair For a via m_Layer contains the top layer, the other layer is in m_BottomLayer. More...
 
void SetBottomLayer (PCB_LAYER_ID aLayer)
 
void SetTopLayer (PCB_LAYER_ID aLayer)
 
void LayerPair (PCB_LAYER_ID *top_layer, PCB_LAYER_ID *bottom_layer) const
 Function LayerPair Return the 2 layers used by the via (the via actually uses all layers between these 2 layers) More...
 
PCB_LAYER_ID TopLayer () const
 
PCB_LAYER_ID BottomLayer () const
 
void SanitizeLayers ()
 Function SanitizeLayers Check so that the layers are correct dependin on the type of via, and so that the top actually is on top. More...
 
const wxPoint GetPosition () const override
 
void SetPosition (const wxPoint &aPoint) override
 
virtual bool HitTest (const wxPoint &aPosition) const override
 Function HitTest tests if aPosition is contained within or on the bounding area of an item. More...
 
virtual bool HitTest (const EDA_RECT &aRect, bool aContained=true, int aAccuracy=0) const override
 Function HitTest tests if the aRect intersects or contains this object (depending on aContained). More...
 
wxString GetClass () const override
 Function GetClass returns the class name. More...
 
wxString GetSelectMenuText () 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_ITEMClone () const override
 Function Clone creates a duplicate of this item with linked list members set to NULL. 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 unsigned int ViewGetLOD (int aLayer, KIGFX::VIEW *aView) const override
 Function ViewGetLOD() Returns the level of detail (LOD) of the item. More...
 
virtual void Flip (const wxPoint &aCentre) override
 Function Flip Flip this object, i.e. More...
 
VIATYPE_T GetViaType () const
 
void SetViaType (VIATYPE_T aViaType)
 
void SetDrill (int aDrill)
 Function SetDrill sets the drill value for vias. More...
 
int GetDrill () const
 Function GetDrill returns the local drill setting for this VIA. More...
 
int GetDrillValue () const
 Function GetDrillValue "calculates" the drill value for vias (m-Drill if > 0, or default drill value for the board. More...
 
void SetDrillDefault ()
 Function SetDrillDefault sets the drill value for vias to the default value UNDEFINED_DRILL_DIAMETER. More...
 
bool IsDrillDefault () const
 Function IsDrillDefault. More...
 
virtual void SwapData (BOARD_ITEM *aImage) override
 Swap data between aItem and aImage. More...
 
TRACKNext () const
 
TRACKBack () const
 
virtual void Move (const wxPoint &aMoveVector) override
 Function Move move this object. More...
 
void Move (const VECTOR2I &aMoveVector)
 
virtual void Rotate (const wxPoint &aRotCentre, double aAngle) override
 Function Rotate Rotate this object. More...
 
void Rotate (const VECTOR2I &aRotCentre, double aAngle)
 
void Flip (const VECTOR2I &aCentre)
 
void SetWidth (int aWidth)
 
int GetWidth () const
 
void SetEnd (const wxPoint &aEnd)
 
const wxPointGetEnd () const
 
void SetStart (const wxPoint &aStart)
 
const wxPointGetStart () const
 
const wxPointGetEndPoint (ENDPOINT_T aEndPoint) const
 Return the selected endpoint (start or end) More...
 
const EDA_RECT GetBoundingBox () const override
 Function GetBoundingBox returns the orthogonal, bounding box of this object for display purposes. More...
 
bool IsLocked () const override
 Function IsLocked. More...
 
void SetLocked (bool aLocked) override
 Function SetLocked modifies 'lock' status for of the item. More...
 
TRACKGetBestInsertPoint (BOARD *aPcb)
 Function GetBestInsertPoint searches the "best" insertion point within the track linked list. More...
 
TRACKGetStartNetCode (int NetCode)
 
TRACKGetEndNetCode (int NetCode)
 
double GetLength () const
 Function GetLength returns the length of the track using the hypotenuse calculation. More...
 
void TransformShapeWithClearanceToPolygon (SHAPE_POLY_SET &aCornerBuffer, int aClearanceValue, int aCircleToSegmentsCount, double aCorrectionFactor) const override
 Function TransformShapeWithClearanceToPolygon Convert the track shape to a closed polygon Used in filling zones calculations Circles (vias) and arcs (ends of tracks) are approximated by segments. More...
 
STATUS_FLAGS IsPointOnEnds (const wxPoint &point, int min_dist=0)
 Function IsPointOnEnds returns STARTPOINT if point if near (dist = min_dist) start point, ENDPOINT if point if near (dist = min_dist) end point,STARTPOINT|ENDPOINT if point if near (dist = min_dist) both ends, or 0 if none of the above. More...
 
bool IsNull ()
 Function IsNull returns true if segment length is zero. More...
 
void GetMsgPanelInfo (std::vector< MSG_PANEL_ITEM > &aList) override
 Function GetMsgPanelInfo populates aList of MSG_PANEL_ITEM objects with it's internal state for display purposes. More...
 
wxString ShowWidth () const
 Function ShowWidth returns the width of the track in displayable user units. More...
 
SEARCH_RESULT Visit (INSPECTOR inspector, void *testData, const KICAD_T scanTypes[]) override
 Function Visit may be re-implemented for each derived class in order to handle all the types given by its member data. More...
 
VIAGetVia (const wxPoint &aPosition, PCB_LAYER_ID aLayer=UNDEFINED_LAYER)
 Function GetVia finds the first VIA object at aPosition on aLayer starting at the trace. More...
 
VIAGetVia (TRACK *aEndTrace, const wxPoint &aPosition, LSET aLayerMask)
 Function GetVia finds the first VIA object at aPosition on aLayer starting at the trace and ending at aEndTrace. More...
 
TRACKGetTrack (TRACK *aStartTrace, TRACK *aEndTrace, ENDPOINT_T aEndPoint, bool aSameNetOnly, bool aSequential)
 Function GetTrack returns the trace segment connected to the segment at aEndPoint from aStartTrace to aEndTrace. More...
 
int GetEndSegments (int NbSegm, TRACK **StartTrack, TRACK **EndTrack)
 Function GetEndSegments get the segments connected to the end point of the track. More...
 
virtual int GetClearance (BOARD_CONNECTED_ITEM *aItem=NULL) const override
 Function GetClearance returns the clearance in internal units. More...
 
const BOX2I ViewBBox () const override
 Function ViewBBox() returns the bounding box of the item covering all its layers. More...
 
bool IsConnected () const override
 > More...
 
NETINFO_ITEMGetNet () const
 Function GetNet Returns NET_INFO object for a given item. More...
 
void SetNet (NETINFO_ITEM *aNetInfo)
 Function SetNet Sets a NET_INFO object for the item. More...
 
int GetNetCode () const
 Function GetNetCode. More...
 
bool SetNetCode (int aNetCode, bool aNoAssert=false)
 Function SetNetCode sets net using a net code. More...
 
const wxString & GetNetname () const
 Function GetNetname. More...
 
const wxString & GetShortNetname () const
 Function GetShortNetname. More...
 
std::shared_ptr< NETCLASSGetNetClass () const
 Function GetNetClass returns the NETCLASS for this item. More...
 
wxString GetNetClassName () const
 Function GetNetClassName returns a pointer to the netclass of the zone. More...
 
void SetLocalRatsnestVisible (bool aVisible)
 
bool GetLocalRatsnestVisible () const
 
virtual const wxPoint GetCenter () const
 Function GetCenter() More...
 
BOARD_ITEM_CONTAINERGetParent () const
 
virtual PCB_LAYER_ID GetLayer () const
 Function GetLayer returns the primary layer this item is on. More...
 
virtual void SetLayer (PCB_LAYER_ID aLayer)
 Function SetLayer sets the layer this item is on. More...
 
bool IsTrack () const
 Function IsTrack tests to see if this object is a track or via (or microvia). 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...
 
virtual BOARDGetBoard () 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...
 
KICAD_T Type () const
 Function Type() More...
 
void SetTimeStamp (timestamp_t aNewTimeStamp)
 
timestamp_t GetTimeStamp () const
 
DHEADGetList () const
 
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
 
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 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 void ViewDraw (int aLayer, VIEW *aView) const
 Function ViewDraw() Draws the parts of the object belonging to layer aLayer. More...
 
VIEW_ITEM_DATA * viewPrivData () const
 

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 std::string FormatInternalUnits (int aValue)
 Function FormatInternalUnits converts aValue from board internal units to a string appropriate for writing to file. More...
 
static std::string FormatInternalUnits (const wxPoint &aPoint)
 
static std::string FormatInternalUnits (const VECTOR2I &aPoint)
 
static std::string FormatInternalUnits (const wxSize &aSize)
 
static std::string FormatAngle (double aAngle)
 Function FormatAngle converts aAngle from board units to a string appropriate for writing to file. 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...
 

Public Attributes

BOARD_CONNECTED_ITEMstart
 
BOARD_CONNECTED_ITEMend
 
double m_Param
 

Static Public Attributes

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

Protected Member Functions

virtual void GetMsgPanelInfoBase (std::vector< MSG_PANEL_ITEM > &aList) override
 Function GetMsgPanelInfoBase Display info about the track segment only, and does not calculate the full track length. More...
 
void GetMsgPanelInfoBase_Common (std::vector< MSG_PANEL_ITEM > &aList)
 Helper function for the common panel info. More...
 
void DrawShortNetname (EDA_DRAW_PANEL *panel, wxDC *aDC, GR_DRAWMODE aDrawMode, COLOR4D aBgColor)
 Helper for drawing the short netname in tracks. More...
 
bool Matches (const wxString &aText, wxFindReplaceData &aSearchData)
 Function Matches compares aText against search criteria in aSearchData. More...
 

Static Protected Member Functions

static int getTrailingInt (const wxString &aStr)
 
static int getNextNumberInSequence (const std::set< int > &aSeq, bool aFillSequenceGaps)
 

Protected Attributes

int m_Width
 Thickness of track, or via diameter. More...
 
wxPoint m_Start
 Line start point. More...
 
wxPoint m_End
 Line end point. More...
 
NETINFO_ITEMm_netinfo
 Stores all informations about the net that item belongs to. More...
 
PCB_LAYER_ID m_Layer
 
EDA_ITEMPnext
 next in linked list More...
 
EDA_ITEMPback
 previous in linked list More...
 
DHEADm_List
 which DLIST I am on. More...
 
EDA_ITEMm_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

PCB_LAYER_ID m_BottomLayer
 The bottom layer of the via (the top layer is in m_Layer) More...
 
VIATYPE_T m_ViaType
 
int m_Drill
 

Detailed Description

Definition at line 382 of file class_track.h.

Constructor & Destructor Documentation

VIA::VIA ( BOARD_ITEM aParent)

Definition at line 158 of file class_track.cpp.

References B_Cu, m_BottomLayer, SetDrillDefault(), SetViaType(), and VIA_THROUGH.

Referenced by Clone().

158  :
159  TRACK( aParent, PCB_VIA_T )
160 {
163  SetDrillDefault();
164 }
void SetViaType(VIATYPE_T aViaType)
Definition: class_track.h:461
PCB_LAYER_ID m_BottomLayer
The bottom layer of the via (the top layer is in m_Layer)
Definition: class_track.h:504
void SetDrillDefault()
Function SetDrillDefault sets the drill value for vias to the default value UNDEFINED_DRILL_DIAMETER...
Definition: class_track.h:489
class VIA, a via (like a track segment on a copper layer)
Definition: typeinfo.h:96
TRACK(BOARD_ITEM *aParent, KICAD_T idtype=PCB_TRACE_T)
Definition: class_track.cpp:96

Member Function Documentation

TRACK* TRACK::Back ( ) const
inlineinherited

Definition at line 100 of file class_track.h.

References EDA_ITEM::Pback.

Referenced by PCB_EDIT_FRAME::Add45DegreeSegment(), ComputeBreakPoint(), TRACK::GetBestInsertPoint(), TRACK::GetMsgPanelInfo(), TRACK::GetTrack(), and Magnetize().

100 { return static_cast<TRACK*>( Pback ); }
EDA_ITEM * Pback
previous in linked list
Definition: base_struct.h:176
PCB_LAYER_ID VIA::BottomLayer ( ) const

Definition at line 461 of file class_track.cpp.

References m_BottomLayer.

Referenced by DIALOG_TRACK_VIA_PROPERTIES::DIALOG_TRACK_VIA_PROPERTIES().

462 {
463  return m_BottomLayer;
464 }
PCB_LAYER_ID m_BottomLayer
The bottom layer of the via (the top layer is in m_Layer)
Definition: class_track.h:504
static bool VIA::ClassOf ( const EDA_ITEM aItem)
inlinestatic

Definition at line 387 of file class_track.h.

References TRACK::Draw(), BOARD_ITEM::GetLayerSet(), BOARD_ITEM::IsOnLayer(), PCB_VIA_T, EDA_ITEM::Type(), and BOARD_ITEM::ZeroOffset.

388  {
389  return aItem && PCB_VIA_T == aItem->Type();
390  }
KICAD_T Type() const
Function Type()
Definition: base_struct.h:209
class VIA, a via (like a track segment on a copper layer)
Definition: typeinfo.h:96
void EDA_ITEM::ClearBrightened ( )
inlineinherited

Definition at line 244 of file base_struct.h.

References BRIGHTENED, EDA_ITEM::ClearFlags(), and EDA_ITEM::SetModified().

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

244 { ClearFlags( BRIGHTENED ); }
#define BRIGHTENED
item is drawn with a bright contour
Definition: base_struct.h:133
void ClearFlags(STATUS_FLAGS aMask=EDA_ITEM_ALL_FLAGS)
Definition: base_struct.h:265
void EDA_ITEM::ClearFlags ( STATUS_FLAGS  aMask = EDA_ITEM_ALL_FLAGS)
inlineinherited

Definition at line 265 of file base_struct.h.

Referenced by Abort_Edit_Pcb_Text(), Abort_EditEdge(), Abort_Move_ModuleOutline(), Abort_Move_Pad(), Abort_MoveOrCopyModule(), Abort_MoveTrack(), Abort_Zone_Create_Outline(), Abort_Zone_Move_Corner_Or_Outlines(), AbortMoveAndEditTarget(), abortMoveBitmap(), AbortMoveDimensionText(), abortMoveItem(), AbortMoveTextModule(), AbortPinMove(), SCH_SCREEN::addConnectedItemsToBlock(), SCH_EDIT_FRAME::addCurrentItemToList(), PNS_KICAD_IFACE::AddItem(), PCB_EDIT_FRAME::AppendBoardFile(), PCB_EDIT_FRAME::Begin_DrawSegment(), FOOTPRINT_EDIT_FRAME::Begin_Edge_Module(), PCB_EDIT_FRAME::Begin_Zone(), SCH_EDIT_FRAME::BeginSegment(), PCB_EDIT_FRAME::Block_Delete(), PCB_EDIT_FRAME::Block_Flip(), PCB_EDIT_FRAME::Block_Move(), PCB_EDIT_FRAME::Change_Side_Module(), SCH_SCREEN::ClearAnnotation(), EDA_ITEM::ClearBrightened(), EDA_ITEM::ClearHighlighted(), DRAG_LIST::ClearList(), ClearMarkItems(), clearModuleItemFlags(), EDA_ITEM::ClearSelected(), SCH_EDIT_FRAME::ConvertPart(), SCH_EDIT_FRAME::copyBlockItems(), CopyMarkedItems(), DIALOG_EDIT_COMPONENT_IN_SCHEMATIC::copyPanelToOptions(), MWAVE::CreateMicrowaveInductor(), FOOTPRINT_EDIT_FRAME::CreateTextModule(), PCB_EDIT_FRAME::Delete_LastCreatedCorner(), PCB_EDIT_FRAME::Delete_Segment_Edge(), DIALOG_LIB_EDIT_PIN::DIALOG_LIB_EDIT_PIN(), PCB_EDIT_FRAME::EditDimension(), PCB_EDIT_FRAME::End_Edge(), FOOTPRINT_EDIT_FRAME::End_Edge_Module(), PCB_EDIT_FRAME::End_Move_Zone_Corner_Or_Outlines(), PCB_EDIT_FRAME::End_Route(), PCB_EDIT_FRAME::End_Zone(), EraseDragList(), PCB_EDIT_FRAME::Exchange_Module(), ExitSheet(), SCH_SCREEN::GetConnection(), PCB_BASE_FRAME::GlobalChange_PadSettings(), PCB_BASE_FRAME::Import_Pad_Settings(), 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(), FOOTPRINT_EDIT_FRAME::Load_Module_From_BOARD(), MarkItemsInBloc(), MirrorX(), MirrorY(), moveBitmap(), FOOTPRINT_EDIT_FRAME::OnEditItemRequest(), LIB_EDIT_FRAME::OnEditPin(), FOOTPRINT_EDIT_FRAME::OnLeftClick(), SCH_EDIT_FRAME::OnLeftClick(), PCB_EDIT_FRAME::OnLeftClick(), LIB_EDIT_FRAME::OnRotateItem(), SCH_EDIT_FRAME::OnSelectUnit(), FOOTPRINT_EDIT_FRAME::OpenProjectFiles(), SCH_FIELD::Place(), PCB_EDIT_FRAME::Place_DrawItem(), FOOTPRINT_EDIT_FRAME::Place_EdgeMod(), PCB_EDIT_FRAME::Place_Texte_Pcb(), PCB_EDIT_FRAME::PlaceDimensionText(), PCB_EDIT_FRAME::PlaceDraggedOrMovedTrackSegment(), PCB_BASE_FRAME::PlaceModule(), PCB_BASE_FRAME::PlacePad(), PCB_EDIT_FRAME::PlaceTarget(), DRAWING_TOOL::PlaceText(), PCB_BASE_FRAME::PlaceTexteModule(), FOOTPRINT_EDIT_FRAME::Process_Special_Functions(), LIB_EDIT_FRAME::Process_Special_Functions(), EDIT_TOOL::Properties(), BOARD_COMMIT::Push(), PCB_BASE_EDIT_FRAME::PutDataInPreviousState(), SCH_EDIT_FRAME::PutDataInPreviousState(), SCH_EDIT_FRAME::RepeatDrawItem(), LIB_EDIT_FRAME::RepeatPinItem(), BOARD_COMMIT::Revert(), PCB_BASE_FRAME::Rotate_Module(), RotateListOfItems(), PCB_BASE_EDIT_FRAME::SaveCopyInUndoList(), SCH_LEGACY_PLUGIN_CACHE::savePin(), FOOTPRINT_VIEWER_FRAME::SelectCurrentFootprint(), SCH_EDIT_FRAME::SetRepeatItem(), PCB_EDIT_FRAME::Start_DragTrackSegmentAndKeepSlope(), PCB_EDIT_FRAME::StartMoveModule(), PCB_EDIT_FRAME::StartMoveOneNodeOrSegment(), and DIALOG_PAD_PROPERTIES::TransferDataFromWindow().

265 { m_Flags &= ~aMask; }
STATUS_FLAGS m_Flags
Flag bits for editing and other uses.
Definition: base_struct.h:186
void EDA_ITEM::ClearHighlighted ( )
inlineinherited

Definition at line 243 of file base_struct.h.

References EDA_ITEM::ClearFlags(), and HIGHLIGHTED.

243 { ClearFlags( HIGHLIGHTED ); }
#define HIGHLIGHTED
item is drawn in normal colors, when the rest is darkened
Definition: base_struct.h:132
void ClearFlags(STATUS_FLAGS aMask=EDA_ITEM_ALL_FLAGS)
Definition: base_struct.h:265
void EDA_ITEM::ClearSelected ( )
inlineinherited
EDA_ITEM * VIA::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 TRACK.

Definition at line 167 of file class_track.cpp.

References VIA().

168 {
169  return new VIA( *this );
170 }
VIA(BOARD_ITEM *aParent)
void BOARD_ITEM::DeleteStructure ( )
inherited
void VIA::Draw ( EDA_DRAW_PANEL panel,
wxDC *  DC,
GR_DRAWMODE  aDrawMode,
const wxPoint offset = ZeroOffset 
)
overridevirtual

Function Draw BOARD_ITEMs have their own color information.

Reimplemented from TRACK.

Definition at line 816 of file class_track.cpp.

References KIGFX::COLOR4D::a, B_Cu, BLACK, color, PCB_GENERAL_SETTINGS::Colors(), DARKDARKGRAY, DrawGraphicHaloText(), FILLED, BOARD_ITEM::GetBoard(), TRACK::GetClearance(), EDA_DRAW_PANEL::GetClipBox(), BOARD::GetCopperLayerCount(), PCB_BASE_FRAME::GetDisplayOptions(), GetDrillValue(), GetGRForceBlackPenState(), COLORS_DESIGN_SETTINGS::GetItemColor(), GetLayerSet(), BOARD_CONNECTED_ITEM::GetNet(), BOARD_CONNECTED_ITEM::GetNetCode(), EDA_DRAW_PANEL::GetParent(), EDA_DRAW_PANEL::GetScreen(), PCB_BASE_FRAME::GetScreen(), NETINFO_ITEM::GetShortNetname(), GetViaType(), BOARD::GetVisibleLayers(), GR_AND, GR_COPY, GR_HIGHLIGHT, GR_TEXT_HJUSTIFY_CENTER, GR_TEXT_VJUSTIFY_CENTER, GR_XOR, GRCircle(), GRFilledCircle(), GRForceBlackPen(), GRLine(), GRSetDrawMode(), BOARD::IsElementVisible(), IsOnLayer(), LAYER_VIAS, LayerPair(), BASE_SCREEN::m_IsPrinting, TRACK::m_Start, TRACK::m_Width, MIN_TEXT_SIZE, MIN_VIA_DRAW_SIZE, RotatePoint(), PCB_BASE_FRAME::Settings(), ShowClearance(), NETINFO_LIST::UNCONNECTED, VIA_BLIND_BURIED, VIA_MICROVIA, WHITE, wxPoint::x, and wxPoint::y.

817 {
818  wxCHECK_RET( panel != NULL, wxT( "VIA::Draw panel cannot be NULL." ) );
819 
820  int radius;
821  PCB_LAYER_ID curr_layer = ( (PCB_SCREEN*) panel->GetScreen() )->m_Active_Layer;
822 
823  int fillvia = 0;
824  PCB_BASE_FRAME* frame = (PCB_BASE_FRAME*) panel->GetParent();
825  PCB_SCREEN* screen = frame->GetScreen();
826  auto displ_opts = (PCB_DISPLAY_OPTIONS*)( frame->GetDisplayOptions() );
827 
828  if( displ_opts->m_DisplayViaFill == FILLED )
829  fillvia = 1;
830 
831  GRSetDrawMode( aDC, aDrawMode );
832 
833  BOARD * brd = GetBoard();
835 
836  if( brd->IsElementVisible( LAYER_VIAS + GetViaType() ) == false
837  && !( aDrawMode & GR_HIGHLIGHT ) )
838  return;
839 
840  // Only draw the via if at least one of the layers it crosses is being displayed
841  if( !( brd->GetVisibleLayers() & GetLayerSet() ).any() )
842  return;
843 
844  if( displ_opts->m_ContrastModeDisplay )
845  {
846  if( !IsOnLayer( curr_layer ) )
847  color = COLOR4D( DARKDARKGRAY );
848  }
849 
850  if( ( aDrawMode & GR_HIGHLIGHT ) && !( aDrawMode & GR_AND ) )
851  color.SetToLegacyHighlightColor();
852 
853  color.a = 0.588;
854 
855 
856  radius = m_Width >> 1;
857  // for small via size on screen (radius < 4 pixels) draw a simplified shape
858 
859  int radius_in_pixels = aDC->LogicalToDeviceXRel( radius );
860 
861  bool fast_draw = false;
862 
863  // Vias are drawn as a filled circle or a double circle. The hole will be drawn later
864  int drill_radius = GetDrillValue() / 2;
865 
866  int inner_radius = radius - aDC->DeviceToLogicalXRel( 2 );
867 
868  if( radius_in_pixels < MIN_VIA_DRAW_SIZE )
869  {
870  fast_draw = true;
871  fillvia = false;
872  }
873 
874  if( fillvia )
875  {
876  GRFilledCircle( panel->GetClipBox(), aDC, m_Start + aOffset, radius, color );
877  }
878  else
879  {
880  GRCircle( panel->GetClipBox(), aDC, m_Start + aOffset, radius, 0, color );
881 
882  if ( fast_draw )
883  return;
884 
885  GRCircle( panel->GetClipBox(), aDC, m_Start + aOffset, inner_radius, 0, color );
886  }
887 
888  if( fillvia )
889  {
890  bool blackpenstate = false;
891 
892  if( screen->m_IsPrinting )
893  {
894  blackpenstate = GetGRForceBlackPenState();
895  GRForceBlackPen( false );
896  color = WHITE;
897  }
898  else
899  {
900  color = BLACK; // or DARKGRAY;
901  }
902 
903  if( (aDrawMode & GR_XOR) == 0)
904  GRSetDrawMode( aDC, GR_COPY );
905 
906  // Draw hole if the radius is > 1pixel.
907  if( aDC->LogicalToDeviceXRel( drill_radius ) > 1 )
908  GRFilledCircle( panel->GetClipBox(), aDC, m_Start.x + aOffset.x,
909  m_Start.y + aOffset.y, drill_radius, 0, color, color );
910 
911  if( screen->m_IsPrinting )
912  GRForceBlackPen( blackpenstate );
913  }
914  else
915  {
916  if( drill_radius < inner_radius ) // We can show the via hole
917  GRCircle( panel->GetClipBox(), aDC, m_Start + aOffset, drill_radius, 0, color );
918  }
919 
920  if( ShowClearance( displ_opts, this ) )
921  {
922  GRCircle( panel->GetClipBox(), aDC, m_Start + aOffset, radius + GetClearance(), 0, color );
923  }
924 
925  // for Micro Vias, draw a partial cross : X on component layer, or + on copper layer
926  // (so we can see 2 superimposed microvias ):
927  if( GetViaType() == VIA_MICROVIA )
928  {
929  int ax, ay, bx, by;
930 
931  if( IsOnLayer( B_Cu ) )
932  {
933  ax = radius; ay = 0;
934  bx = drill_radius; by = 0;
935  }
936  else
937  {
938  ax = ay = (radius * 707) / 1000;
939  bx = by = (drill_radius * 707) / 1000;
940  }
941 
942  // lines '|' or '\'
943  GRLine( panel->GetClipBox(), aDC, m_Start.x + aOffset.x - ax,
944  m_Start.y + aOffset.y - ay,
945  m_Start.x + aOffset.x - bx,
946  m_Start.y + aOffset.y - by, 0, color );
947  GRLine( panel->GetClipBox(), aDC, m_Start.x + aOffset.x + bx,
948  m_Start.y + aOffset.y + by,
949  m_Start.x + aOffset.x + ax,
950  m_Start.y + aOffset.y + ay, 0, color );
951 
952  // lines - or '/'
953  GRLine( panel->GetClipBox(), aDC, m_Start.x + aOffset.x + ay,
954  m_Start.y + aOffset.y - ax,
955  m_Start.x + aOffset.x + by,
956  m_Start.y + aOffset.y - bx, 0, color );
957  GRLine( panel->GetClipBox(), aDC, m_Start.x + aOffset.x - by,
958  m_Start.y + aOffset.y + bx,
959  m_Start.x + aOffset.x - ay,
960  m_Start.y + aOffset.y + ax, 0, color );
961  }
962 
963  // for Buried Vias, draw a partial line : orient depending on layer pair
964  // (so we can see superimposed buried vias ):
965  if( GetViaType() == VIA_BLIND_BURIED )
966  {
967  int ax = 0, ay = radius, bx = 0, by = drill_radius;
968  PCB_LAYER_ID layer_top, layer_bottom;
969 
970  LayerPair( &layer_top, &layer_bottom );
971 
972  // lines for the top layer
973  RotatePoint( &ax, &ay, layer_top * 3600.0 / brd->GetCopperLayerCount( ) );
974  RotatePoint( &bx, &by, layer_top * 3600.0 / brd->GetCopperLayerCount( ) );
975  GRLine( panel->GetClipBox(), aDC, m_Start.x + aOffset.x - ax,
976  m_Start.y + aOffset.y - ay,
977  m_Start.x + aOffset.x - bx,
978  m_Start.y + aOffset.y - by, 0, color );
979 
980  // lines for the bottom layer
981  ax = 0; ay = radius; bx = 0; by = drill_radius;
982  RotatePoint( &ax, &ay, layer_bottom * 3600.0 / brd->GetCopperLayerCount( ) );
983  RotatePoint( &bx, &by, layer_bottom * 3600.0 / brd->GetCopperLayerCount( ) );
984  GRLine( panel->GetClipBox(), aDC, m_Start.x + aOffset.x - ax,
985  m_Start.y + aOffset.y - ay,
986  m_Start.x + aOffset.x - bx,
987  m_Start.y + aOffset.y - by, 0, color );
988  }
989 
990  // Display the short netname:
992  return;
993 
994  if( displ_opts->m_DisplayNetNamesMode == 0 || displ_opts->m_DisplayNetNamesMode == 1 )
995  return;
996 
997  NETINFO_ITEM* net = GetNet();
998 
999  if( net == NULL )
1000  return;
1001 
1002  int len = net->GetShortNetname().Len();
1003 
1004  if( len > 0 )
1005  {
1006  // calculate a good size for the text
1007  int tsize = m_Width / len;
1008 
1009  if( aDC->LogicalToDeviceXRel( tsize ) >= MIN_TEXT_SIZE )
1010  {
1011  tsize = (tsize * 7) / 10; // small reduction to give a better look, inside via
1012 
1013  if( (aDrawMode & GR_XOR) == 0 )
1014  GRSetDrawMode( aDC, GR_COPY );
1015 
1016  EDA_RECT* clipbox = panel->GetClipBox();
1017  DrawGraphicHaloText( clipbox, aDC, m_Start,
1018  color, WHITE, BLACK, net->GetShortNetname(), 0,
1019  wxSize( tsize, tsize ),
1021  tsize / 7, false, false );
1022  }
1023  }
1024 }
#define MIN_VIA_DRAW_SIZE
Definition: class_track.h:61
wxPoint m_Start
Line start point.
Definition: class_track.h:342
void GRSetDrawMode(wxDC *DC, GR_DRAWMODE draw_mode)
Definition: gr_basic.cpp:318
virtual LSET GetLayerSet() const override
Function GetLayerSet returns a "layer mask", which is a bitmap of all layers on which the TRACK segme...
int color
Definition: DXF_plotter.cpp:62
int GetCopperLayerCount() const
Function GetCopperLayerCount.
static bool ShowClearance(PCB_DISPLAY_OPTIONS *aDisplOpts, const TRACK *aTrack)
Function ShowClearance tests to see if the clearance border is drawn on the given track...
Definition: class_track.cpp:55
void RotatePoint(int *pX, int *pY, double angle)
Definition: trigo.cpp:216
void GRFilledCircle(EDA_RECT *ClipBox, wxDC *DC, int x, int y, int r, int width, COLOR4D Color, COLOR4D BgColor)
Definition: gr_basic.cpp:873
void DrawGraphicHaloText(EDA_RECT *aClipBox, wxDC *aDC, const wxPoint &aPos, const COLOR4D aBgColor, COLOR4D aColor1, COLOR4D aColor2, const wxString &aText, double aOrient, const wxSize &aSize, enum EDA_TEXT_HJUSTIFY_T aH_justify, enum EDA_TEXT_VJUSTIFY_T aV_justify, int aWidth, bool aItalic, bool aBold, void(*aCallback)(int x0, int y0, int xf, int yf, void *aData), void *aCallbackData, PLOTTER *aPlotter)
Draw graphic text with a border, so that it can be read on different backgrounds. ...
void * GetDisplayOptions() override
Function GetDisplayOptions returns the display options current in use Display options are relative to...
#define MIN_TEXT_SIZE
int m_Width
Thickness of track, or via diameter.
Definition: class_track.h:341
COLOR4D GetItemColor(int aItemIdx) const
Function GetItemColor.
const wxString & GetShortNetname() const
Function GetShortNetname.
Definition: netinfo.h:241
Class PCB_DISPLAY_OPTIONS handles display options like enable/disable some optional drawings...
PCB_LAYER_ID
A quick note on layer IDs:
double a
Alpha component.
Definition: color4d.h:294
VIATYPE_T GetViaType() const
Definition: class_track.h:460
void GRForceBlackPen(bool flagforce)
Function GRForceBlackPen.
Definition: gr_basic.cpp:299
PCB_GENERAL_SETTINGS & Settings()
EDA_RECT * GetClipBox()
EDA_DRAW_FRAME * GetParent() const
Definition: draw_panel.cpp:180
virtual int GetClearance(BOARD_CONNECTED_ITEM *aItem=NULL) const override
Function GetClearance returns the clearance in internal units.
void GRLine(EDA_RECT *ClipBox, wxDC *DC, int x1, int y1, int x2, int y2, int width, COLOR4D Color, wxPenStyle aStyle)
Definition: gr_basic.cpp:380
bool m_IsPrinting
Definition: base_screen.h:220
COLORS_DESIGN_SETTINGS & Colors()
void LayerPair(PCB_LAYER_ID *top_layer, PCB_LAYER_ID *bottom_layer) const
Function LayerPair Return the 2 layers used by the via (the via actually uses all layers between thes...
int GetNetCode() const
Function GetNetCode.
Class NETINFO_ITEM handles the data for a net.
Definition: netinfo.h:69
bool IsElementVisible(GAL_LAYER_ID aLayer) const
Function IsElementVisible tests whether a given element category is visible.
int GetDrillValue() const
Function GetDrillValue "calculates" the drill value for vias (m-Drill if > 0, or default drill value ...
Class BOARD holds information pertinent to a Pcbnew printed circuit board.
Definition: class_board.h:169
LSET GetVisibleLayers() const
Function GetVisibleLayers is a proxy function that calls the correspondent function in m_BoardSetting...
void GRCircle(EDA_RECT *ClipBox, wxDC *DC, int xc, int yc, int r, int width, COLOR4D Color)
Definition: gr_basic.cpp:850
Class EDA_RECT handles the component boundary box.
Definition: eda_rect.h:44
BASE_SCREEN * GetScreen()
Definition: draw_panel.cpp:193
PCB_SCREEN * GetScreen() const override
Function GetScreen returns a pointer to a BASE_SCREEN or one of its derivatives.
Definition: colors.h:49
virtual BOARD * GetBoard() const
Function GetBoard returns the BOARD in which this BOARD_ITEM resides, or NULL if none.
bool IsOnLayer(PCB_LAYER_ID aLayer) const override
Function IsOnLayer tests to see if this object is on the given layer.
Definition: colors.h:45
bool GetGRForceBlackPenState(void)
Function GetGRForceBlackPenState.
Definition: gr_basic.cpp:309
static const int UNCONNECTED
Constant that holds the "unconnected net" number (typically 0) all items "connected" to this net are ...
Definition: netinfo.h:461
class PCB_BASE_FRAME basic PCB main window class for Pcbnew, Gerbview, and CvPcb footprint viewer...
NETINFO_ITEM * GetNet() const
Function GetNet Returns NET_INFO object for a given item.
Class COLOR4D is the color representation with 4 components: red, green, blue, alpha.
Definition: color4d.h:39
void TRACK::DrawShortNetname ( EDA_DRAW_PANEL panel,
wxDC *  aDC,
GR_DRAWMODE  aDrawMode,
COLOR4D  aBgColor 
)
protectedinherited

Helper for drawing the short netname in tracks.

Definition at line 567 of file class_track.cpp.

References PNS::angle(), BLACK, DrawGraphicHaloText(), EDA_DRAW_PANEL::GetClipBox(), EDA_DRAW_PANEL::GetDisplayOptions(), GetLineLength(), BOARD_CONNECTED_ITEM::GetNet(), BOARD_CONNECTED_ITEM::GetNetCode(), EDA_DRAW_PANEL::GetScreen(), NETINFO_ITEM::GetShortNetname(), GR_COPY, GR_TEXT_HJUSTIFY_CENTER, GR_TEXT_VJUSTIFY_CENTER, GR_XOR, GRSetDrawMode(), IsOnLayer(), KiROUND(), TRACK::m_End, TRACK::m_Start, TRACK::m_Width, min, MIN_TEXT_SIZE, RAD2DECIDEG(), THRESHOLD, NETINFO_LIST::UNCONNECTED, WHITE, wxPoint::x, and wxPoint::y.

Referenced by TRACK::Draw(), and TRACK::GetClass().

569 {
570  if( ! panel )
571  return;
572 
573  /* we must filter tracks, to avoid a lot of texts.
574  * - only tracks with a length > 10 * thickness are eligible
575  * and, of course, if we are not printing the board
576  */
577  auto displ_opts = (PCB_DISPLAY_OPTIONS*)( panel->GetDisplayOptions() );
578 
579  if( displ_opts->m_DisplayNetNamesMode == 0 || displ_opts->m_DisplayNetNamesMode == 1 )
580  return;
581 
582  #define THRESHOLD 10
583 
584  int len = KiROUND( GetLineLength( m_Start, m_End ) );
585 
586  if( len < THRESHOLD * m_Width )
587  return;
588 
589  // no room to display a text inside track
590  if( aDC->LogicalToDeviceXRel( m_Width ) < MIN_TEXT_SIZE )
591  return;
592 
594  return;
595 
596  NETINFO_ITEM* net = GetNet();
597 
598  if( net == NULL )
599  return;
600 
601  int textlen = net->GetShortNetname().Len();
602 
603  if( textlen > 0 )
604  {
605  // calculate a good size for the text
606  int tsize = std::min( m_Width, len / textlen );
607  int dx = m_End.x - m_Start.x ;
608  int dy = m_End.y - m_Start.y ;
609  wxPoint tpos = m_Start + m_End;
610  tpos.x /= 2;
611  tpos.y /= 2;
612 
613  // Calculate angle: if the track segment is vertical, angle = 90 degrees
614  // If horizontal 0 degrees, otherwise compute it
615  double angle; // angle is in 0.1 degree
616 
617  if( dy == 0 ) // Horizontal segment
618  {
619  angle = 0;
620  }
621  else
622  {
623  if( dx == 0 ) // Vertical segment
624  {
625  angle = 900;
626  }
627  else
628  {
629  /* atan2 is *not* the solution here, since it can give upside
630  down text. We want to work only in the first and fourth quadrant */
631  angle = RAD2DECIDEG( -atan( double( dy ) / double( dx ) ) );
632  }
633  }
634 
635  PCB_LAYER_ID curr_layer = ( (PCB_SCREEN*) panel->GetScreen() )->m_Active_Layer;
636 
637  if( ( aDC->LogicalToDeviceXRel( tsize ) >= MIN_TEXT_SIZE )
638  && ( !(!IsOnLayer( curr_layer )&& displ_opts->m_ContrastModeDisplay) ) )
639  {
640  if( (aDrawMode & GR_XOR) == 0 )
641  GRSetDrawMode( aDC, GR_COPY );
642 
643  tsize = (tsize * 7) / 10; // small reduction to give a better look
644  DrawGraphicHaloText( panel->GetClipBox(), aDC, tpos,
645  aBgColor, BLACK, WHITE, net->GetShortNetname(), angle,
646  wxSize( tsize, tsize ),
648  tsize / 7,
649  false, false );
650  }
651  }
652 }
wxPoint m_Start
Line start point.
Definition: class_track.h:342
double GetLineLength(const wxPoint &aPointA, const wxPoint &aPointB)
Function GetLineLength returns the length of a line segment defined by aPointA and aPointB...
Definition: trigo.h:191
void GRSetDrawMode(wxDC *DC, GR_DRAWMODE draw_mode)
Definition: gr_basic.cpp:318
static int KiROUND(double v)
Round a floating point number to an integer using "round halfway cases away from zero".
Definition: common.h:106
virtual bool IsOnLayer(PCB_LAYER_ID aLayer) const
Function IsOnLayer tests to see if this object is on the given layer.
double RAD2DECIDEG(double rad)
Definition: trigo.h:204
void DrawGraphicHaloText(EDA_RECT *aClipBox, wxDC *aDC, const wxPoint &aPos, const COLOR4D aBgColor, COLOR4D aColor1, COLOR4D aColor2, const wxString &aText, double aOrient, const wxSize &aSize, enum EDA_TEXT_HJUSTIFY_T aH_justify, enum EDA_TEXT_VJUSTIFY_T aV_justify, int aWidth, bool aItalic, bool aBold, void(*aCallback)(int x0, int y0, int xf, int yf, void *aData), void *aCallbackData, PLOTTER *aPlotter)
Draw graphic text with a border, so that it can be read on different backgrounds. ...
#define MIN_TEXT_SIZE
int m_Width
Thickness of track, or via diameter.
Definition: class_track.h:341
#define THRESHOLD
const wxString & GetShortNetname() const
Function GetShortNetname.
Definition: netinfo.h:241
Class PCB_DISPLAY_OPTIONS handles display options like enable/disable some optional drawings...
PCB_LAYER_ID
A quick note on layer IDs:
wxPoint m_End
Line end point.
Definition: class_track.h:343
EDA_RECT * GetClipBox()
int GetNetCode() const
Function GetNetCode.
Class NETINFO_ITEM handles the data for a net.
Definition: netinfo.h:69
static DIRECTION_45::AngleType angle(const VECTOR2I &a, const VECTOR2I &b)
BASE_SCREEN * GetScreen()
Definition: draw_panel.cpp:193
Definition: colors.h:49
Definition: colors.h:45
void * GetDisplayOptions()
Function GetDisplayOptions A way to pass info to draw functions.
Definition: draw_panel.cpp:187
static const int UNCONNECTED
Constant that holds the "unconnected net" number (typically 0) all items "connected" to this net are ...
Definition: netinfo.h:461
NETINFO_ITEM * GetNet() const
Function GetNet Returns NET_INFO object for a given item.
#define min(a, b)
Definition: auxiliary.h:85
void BOARD_ITEM::Flip ( const VECTOR2I aCentre)
inlineinherited

Definition at line 271 of file class_board_item.h.

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

272  {
273  Flip( wxPoint( aCentre.x, aCentre.y ) );
274  }
virtual void Flip(const wxPoint &aCentre)
Function Flip Flip this object, i.e.
void VIA::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 TRACK.

Definition at line 342 of file class_track.cpp.

References FlipLayer(), BOARD_ITEM::GetBoard(), BOARD::GetCopperLayerCount(), GetViaType(), LayerPair(), TRACK::m_End, TRACK::m_Start, SetLayerPair(), VIA_THROUGH, and wxPoint::y.

343 {
344  m_Start.y = aCentre.y - (m_Start.y - aCentre.y);
345  m_End.y = aCentre.y - (m_End.y - aCentre.y);
346 
347  if( GetViaType() != VIA_THROUGH )
348  {
349  int copperLayerCount = GetBoard()->GetCopperLayerCount();
350  PCB_LAYER_ID top_layer;
351  PCB_LAYER_ID bottom_layer;
352  LayerPair( &top_layer, &bottom_layer );
353  top_layer = FlipLayer( top_layer, copperLayerCount );
354  bottom_layer = FlipLayer( bottom_layer, copperLayerCount );
355  SetLayerPair( top_layer, bottom_layer );
356  }
357 }
wxPoint m_Start
Line start point.
Definition: class_track.h:342
PCB_LAYER_ID FlipLayer(PCB_LAYER_ID aLayerId, int aCopperLayersCount)
Function FlippedLayerNumber.
Definition: lset.cpp:472
int GetCopperLayerCount() const
Function GetCopperLayerCount.
PCB_LAYER_ID
A quick note on layer IDs:
VIATYPE_T GetViaType() const
Definition: class_track.h:460
wxPoint m_End
Line end point.
Definition: class_track.h:343
void SetLayerPair(PCB_LAYER_ID aTopLayer, PCB_LAYER_ID aBottomLayer)
Function SetLayerPair For a via m_Layer contains the top layer, the other layer is in m_BottomLayer...
void LayerPair(PCB_LAYER_ID *top_layer, PCB_LAYER_ID *bottom_layer) const
Function LayerPair Return the 2 layers used by the via (the via actually uses all layers between thes...
virtual BOARD * GetBoard() const
Function GetBoard returns the BOARD in which this BOARD_ITEM resides, or NULL if none.
std::string BOARD_ITEM::FormatAngle ( double  aAngle)
staticinherited

Function FormatAngle converts aAngle from board units to a string appropriate for writing to file.

Note
Internal angles for board items can be either degrees or tenths of degree on how KiCad is built.
Parameters
aAngleA angle value to convert.
Returns
A std::string object containing the converted angle.

Definition at line 171 of file class_board_item.cpp.

Referenced by BOARD_ITEM::HitTest().

172 {
173  char temp[50];
174 
175  int len = snprintf( temp, sizeof(temp), "%.10g", aAngle / 10.0 );
176 
177  return std::string( temp, len );
178 }
std::string BOARD_ITEM::FormatInternalUnits ( int  aValue)
staticinherited

Function FormatInternalUnits converts aValue from board internal units to a string appropriate for writing to file.

Note
Internal units for board items can be either deci-mils or nanometers depending on how KiCad is build.
Parameters
aValueA coordinate value to convert.
Returns
A std::string object containing the converted value.

Definition at line 90 of file class_board_item.cpp.

Referenced by checkConnectedTo(), ConvertOutlineToPolygon(), BOARD_ITEM::FormatInternalUnits(), BOARD_ITEM::HitTest(), and BOARD::TracksInNetBetweenPoints().

91 {
92 #if 1
93 
94  char buf[50];
95  int len;
96  double mm = aValue / IU_PER_MM;
97 
98  if( mm != 0.0 && fabs( mm ) <= 0.0001 )
99  {
100  len = sprintf( buf, "%.10f", mm );
101 
102  while( --len > 0 && buf[len] == '0' )
103  buf[len] = '\0';
104 
105  if( buf[len] == '.' )
106  buf[len] = '\0';
107  else
108  ++len;
109  }
110  else
111  {
112  len = sprintf( buf, "%.10g", mm );
113  }
114 
115  return std::string( buf, len );
116 
117 #else
118 
119  // Assume aValue is in nanometers, and that we want the result in millimeters,
120  // and that int is 32 bits wide. Then perform an alternative algorithm.
121  // Can be used to verify that the above algorithm is correctly generating text.
122  // Convert aValue into an integer string, then insert a decimal point manually.
123  // Results are the same as above general purpose algorithm.
124 
125  wxASSERT( sizeof(int) == 4 );
126 
127  if( aValue == 0 )
128  return std::string( 1, '0' );
129  else
130  {
131  char buf[50];
132  int len = sprintf( buf, aValue > 0 ? "%06d" : "%07d", aValue ); // optionally pad w/leading zeros
133 
134  std::string ret( buf, len );
135 
136  std::string::iterator it = ret.end() - 1; // last byte
137 
138  // insert '.' at 6 positions from end, dividing by 10e6 (a million), nm => mm
139  std::string::iterator decpoint = ret.end() - 6;
140 
141  // truncate trailing zeros, up to decimal point position
142  for( ; *it=='0' && it >= decpoint; --it )
143  ret.erase( it ); // does not invalidate iterators it or decpoint
144 
145  if( it >= decpoint )
146  {
147  ret.insert( decpoint, '.' );
148 
149  // decpoint is invalidated here, after insert()
150 
151 #if 1 // want a leading zero when decimal point is in first position?
152  if( ret[0] == '.' )
153  {
154  // insert leading zero ahead of decimal point.
155  ret.insert( ret.begin(), '0' );
156  }
157  else if( ret[0]=='-' && ret[1]=='.' )
158  {
159  ret.insert( ret.begin() + 1, '0' );
160  }
161 #endif
162  }
163 
164  return ret;
165  }
166 
167 #endif
168 }
std::string BOARD_ITEM::FormatInternalUnits ( const wxPoint aPoint)
staticinherited

Definition at line 181 of file class_board_item.cpp.

References BOARD_ITEM::FormatInternalUnits(), wxPoint::x, and wxPoint::y.

182 {
183  return FormatInternalUnits( aPoint.x ) + " " + FormatInternalUnits( aPoint.y );
184 }
static std::string FormatInternalUnits(int aValue)
Function FormatInternalUnits converts aValue from board internal units to a string appropriate for wr...
std::string BOARD_ITEM::FormatInternalUnits ( const VECTOR2I aPoint)
staticinherited

Definition at line 187 of file class_board_item.cpp.

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

188 {
189  return FormatInternalUnits( aPoint.x ) + " " + FormatInternalUnits( aPoint.y );
190 }
static std::string FormatInternalUnits(int aValue)
Function FormatInternalUnits converts aValue from board internal units to a string appropriate for wr...
std::string BOARD_ITEM::FormatInternalUnits ( const wxSize &  aSize)
staticinherited

Definition at line 193 of file class_board_item.cpp.

References BOARD_ITEM::FormatInternalUnits().

194 {
195  return FormatInternalUnits( aSize.GetWidth() ) + " " + FormatInternalUnits( aSize.GetHeight() );
196 }
static std::string FormatInternalUnits(int aValue)
Function FormatInternalUnits converts aValue from board internal units to a string appropriate for wr...
TRACK * TRACK::GetBestInsertPoint ( BOARD aPcb)
inherited

Function GetBestInsertPoint searches the "best" insertion point within the track linked list.

The best point is currently the end of the corresponding net code section. (The BOARD::m_Track and BOARD::m_Zone lists are sorted by netcode.)

Parameters
aPcbThe BOARD to search for the insertion point.
Returns
TRACK* - the insertion point in the linked list. this is the next item after the last item having my net code. therefore the track to insert must be inserted before the insertion point. if the best insertion point is the end of list, the returned value is NULL

Definition at line 480 of file class_track.cpp.

References TRACK::Back(), DLIST< T >::GetFirst(), DLIST< T >::GetLast(), BOARD_CONNECTED_ITEM::GetNetCode(), BOARD::m_SegZoneDeprecated, BOARD::m_Track, TRACK::Next(), PCB_ZONE_T, and EDA_ITEM::Type().

Referenced by BOARD::Add(), and TRACK::SetLocked().

481 {
482  TRACK* track;
483 
484  // When reading from a file most of the items will already be in the correct order.
485  // Searching from the back therefore takes us from n^2 to essentially 0.
486 
487  if( Type() == PCB_ZONE_T ) // Deprecated items, only found in very old boards
488  track = aPcb->m_SegZoneDeprecated.GetLast();
489  else
490  track = aPcb->m_Track.GetLast();
491 
492  for( ; track; track = track->Back() )
493  {
494  if( GetNetCode() >= track->GetNetCode() )
495  return track->Next();
496  }
497 
498  if( Type() == PCB_ZONE_T ) // Deprecated
499  return aPcb->m_SegZoneDeprecated.GetFirst();
500  else
501  return aPcb->m_Track.GetFirst();
502 }
KICAD_T Type() const
Function Type()
Definition: base_struct.h:209
TRACK * Back() const
Definition: class_track.h:100
T * GetLast() const
Function GetLast returns the last T* in the list without removing it, or NULL if the list is empty...
Definition: dlist.h:170
DLIST< SEGZONE > m_SegZoneDeprecated
Definition: class_board.h:249
T * GetFirst() const
Function GetFirst returns the first T* in the list without removing it, or NULL if the list is empty...
Definition: dlist.h:163
class SEGZONE, a segment used to fill a zone area (segment on a copper layer)
Definition: typeinfo.h:97
int GetNetCode() const
Function GetNetCode.
TRACK * Next() const
Definition: class_track.h:99
DLIST< TRACK > m_Track
Definition: class_board.h:248
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.

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

Referenced by DIALOG_GEN_FOOTPRINT_POSITION::CreateFiles(), DeleteMarkedItems(), PCB_TARGET::Draw(), TEXTE_PCB::Draw(), EDGE_MODULE::Draw(), ZONE_CONTAINER::Draw(), TEXTE_MODULE::Draw(), TRACK::Draw(), DIMENSION::Draw(), DRAWSEGMENT::Draw(), MODULE::Draw(), SEGZONE::Draw(), Draw(), MODULE::DrawAncre(), ZONE_CONTAINER::DrawFilledArea(), BOARD_PRINTOUT_CONTROLLER::DrawPage(), EVT_COMMAND_RANGE(), TEXTE_PCB::Flip(), TRACK::Flip(), BOARD_ITEM::Flip(), ZONE_CONTAINER::Flip(), Flip(), BOARD_ITEM::GetBoard(), GAL_ARRAY_CREATOR::getBoard(), LEGACY_ARRAY_CREATOR::getBoard(), MODULE::GetBoundingPoly(), BOARD_ITEM::GetLayerName(), TRACK::GetMsgPanelInfo(), NETINFO_ITEM::GetMsgPanelInfo(), D_PAD::GetMsgPanelInfo(), TRACK::GetMsgPanelInfoBase(), SEGZONE::GetMsgPanelInfoBase(), GetMsgPanelInfoBase(), TRACK::GetMsgPanelInfoBase_Common(), BOARD_CONNECTED_ITEM::GetNetClass(), TRACK::GetSelectMenuText(), SEGZONE::GetSelectMenuText(), GetSelectMenuText(), ZONE_CONTAINER::GetSelectMenuText(), D_PAD::GetSelectMenuText(), D_PAD::GetSolderMaskMargin(), D_PAD::GetSolderPasteMargin(), PushTrack(), BOARD_CONNECTED_ITEM::SetNet(), BOARD_CONNECTED_ITEM::SetNetCode(), MODULE::ViewBBox(), ViewGetLOD(), and D_PAD::ViewGetLOD().

65 {
66  if( Type() == PCB_T )
67  return (BOARD*) this;
68 
69  BOARD_ITEM* parent = GetParent();
70 
71  if( parent )
72  return parent->GetBoard();
73 
74  return NULL;
75 }
KICAD_T Type() const
Function Type()
Definition: base_struct.h:209
BOARD_ITEM_CONTAINER * GetParent() const
Definition: typeinfo.h:85
Class BOARD_ITEM is a base class for any item which can be embedded within the BOARD container class...
Class BOARD holds information pertinent to a Pcbnew printed circuit board.
Definition: class_board.h:169
virtual BOARD * GetBoard() const
Function GetBoard returns the BOARD in which this BOARD_ITEM resides, or NULL if none.
const EDA_RECT TRACK::GetBoundingBox ( ) const
overridevirtualinherited

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 290 of file class_track.cpp.

References TRACK::m_End, TRACK::m_Start, TRACK::m_Width, max, min, PCB_VIA_T, EDA_ITEM::Type(), wxPoint::x, and wxPoint::y.

Referenced by PCB_EDIT_FRAME::Delete_Segment(), TRACK::GetEndPoint(), and TRACK::ViewBBox().

291 {
292  // end of track is round, this is its radius, rounded up
293  int radius = ( m_Width + 1 ) / 2;
294  int ymax, xmax, ymin, xmin;
295 
296  if( Type() == PCB_VIA_T )
297  {
298  ymax = m_Start.y;
299  xmax = m_Start.x;
300 
301  ymin = m_Start.y;
302  xmin = m_Start.x;
303  }
304  else
305  {
306  ymax = std::max( m_Start.y, m_End.y );
307  xmax = std::max( m_Start.x, m_End.x );
308 
309  ymin = std::min( m_Start.y, m_End.y );
310  xmin = std::min( m_Start.x, m_End.x );
311  }
312 
313  ymax += radius;
314  xmax += radius;
315 
316  ymin -= radius;
317  xmin -= radius;
318 
319  // return a rectangle which is [pos,dim) in nature. therefore the +1
320  EDA_RECT ret( wxPoint( xmin, ymin ), wxSize( xmax - xmin + 1, ymax - ymin + 1 ) );
321 
322  return ret;
323 }
KICAD_T Type() const
Function Type()
Definition: base_struct.h:209
wxPoint m_Start
Line start point.
Definition: class_track.h:342
int m_Width
Thickness of track, or via diameter.
Definition: class_track.h:341
wxPoint m_End
Line end point.
Definition: class_track.h:343
#define max(a, b)
Definition: auxiliary.h:86
Class EDA_RECT handles the component boundary box.
Definition: eda_rect.h:44
class VIA, a via (like a track segment on a copper layer)
Definition: typeinfo.h:96
#define min(a, b)
Definition: auxiliary.h:85
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 97 of file class_board_item.h.

References BOARD_ITEM::GetPosition(), and BOARD_ITEM::SetPosition().

Referenced by BOARD::chainMarkedSegments(), and DIALOG_CREATE_ARRAY::ARRAY_CIRCULAR_OPTIONS::TransformItem().

97 { return GetPosition(); }
virtual const wxPoint GetPosition() const =0
wxString VIA::GetClass ( ) const
inlineoverridevirtual

Function GetClass returns the class name.

Returns
wxString

Reimplemented from TRACK.

Definition at line 439 of file class_track.h.

References TRACK::Clone(), TRACK::Flip(), TRACK::GetMenuImage(), TRACK::GetSelectMenuText(), TRACK::ViewGetLayers(), and TRACK::ViewGetLOD().

440  {
441  return wxT( "VIA" );
442  }
int TRACK::GetClearance ( BOARD_CONNECTED_ITEM aItem = NULL) const
overridevirtualinherited

Function GetClearance returns the clearance in internal units.

If aItem is not NULL then the returned clearance is the greater of this object's clearance and aItem's clearance. If aItem is NULL, then this objects clearance is returned.

Parameters
aItemis another BOARD_CONNECTED_ITEM or NULL
Returns
int - the clearance in internal units.

Reimplemented from BOARD_CONNECTED_ITEM.

Definition at line 226 of file class_track.cpp.

References BOARD_CONNECTED_ITEM::GetClearance().

Referenced by DRC::doTrackDrc(), TRACK::Draw(), KIGFX::PCB_PAINTER::draw(), Draw(), TRACK::GetClass(), LocateIntrusion(), PushTrack(), and TRACK::ViewBBox().

227 {
228  // Currently tracks have no specific clearance parameter on a per track or per
229  // segment basis. The NETCLASS clearance is used.
230  return BOARD_CONNECTED_ITEM::GetClearance( aItem );
231 }
virtual int GetClearance(BOARD_CONNECTED_ITEM *aItem=NULL) const
Function GetClearance returns the clearance in internal units.
int VIA::GetDrill ( ) const
inline

Function GetDrill returns the local drill setting for this VIA.

If you want the calculated value, use GetDrillValue() instead.

Definition at line 475 of file class_track.h.

Referenced by PCB_IO::format(), EAGLE_PLUGIN::loadSignals(), and PCB_EDIT_FRAME::SetTrackSegmentWidth().

475 { return m_Drill; }
int m_Drill
Definition: class_track.h:508
int VIA::GetDrillValue ( ) const

Function GetDrillValue "calculates" the drill value for vias (m-Drill if > 0, or default drill value for the board.

Returns
real drill_value

Definition at line 234 of file class_track.cpp.

References BOARD_CONNECTED_ITEM::GetNetClass(), GetViaType(), m_Drill, and VIA_MICROVIA.

Referenced by build_via_testpoints(), CINFO3D_VISU::createLayers(), CreatePadsShapesSection(), CreateRoutesSection(), DIALOG_TRACK_VIA_PROPERTIES::DIALOG_TRACK_VIA_PROPERTIES(), DRC::doTrackDrc(), KIGFX::PCB_PAINTER::draw(), Draw(), export_vrml_via(), C3D_RENDER_OGL_LEGACY::generate_3D_Vias_and_Pads(), GetMsgPanelInfoBase(), C3D_RENDER_RAYTRACING::insert3DViaHole(), BRDITEMS_PLOTTER::PlotDrillMarks(), PlotLayerOutlines(), PCB_EDIT_FRAME::PrintPage(), PCB_EDIT_FRAME::SetTrackSegmentWidth(), PNS_KICAD_IFACE::syncVia(), and ViaSort().

235 {
236  if( m_Drill > 0 ) // Use the specific value.
237  return m_Drill;
238 
239  // Use the default value from the Netclass
240  NETCLASSPTR netclass = GetNetClass();
241 
242  if( GetViaType() == VIA_MICROVIA )
243  return netclass->GetuViaDrill();
244 
245  return netclass->GetViaDrill();
246 }
VIATYPE_T GetViaType() const
Definition: class_track.h:460
std::shared_ptr< NETCLASS > GetNetClass() const
Function GetNetClass returns the NETCLASS for this item.
int m_Drill
Definition: class_track.h:508
const wxPoint& TRACK::GetEnd ( ) const
inlineinherited
TRACK * TRACK::GetEndNetCode ( int  NetCode)
inherited

Definition at line 534 of file class_track.cpp.

References BOARD_CONNECTED_ITEM::GetNetCode(), and EDA_ITEM::Pnext.

Referenced by PCB_EDIT_FRAME::EraseRedundantTrack(), and TRACK::SetLocked().

535 {
536  TRACK* NextS, * Track = this;
537  int ii = 0;
538 
539  if( Track == NULL )
540  return NULL;
541 
542  if( NetCode == -1 )
543  NetCode = GetNetCode();
544 
545  while( Track != NULL )
546  {
547  NextS = (TRACK*) Track->Pnext;
548 
549  if( Track->GetNetCode() == NetCode )
550  ii++;
551 
552  if( NextS == NULL )
553  break;
554 
555  if( NextS->GetNetCode() > NetCode )
556  break;
557 
558  Track = NextS;
559  }
560 
561  if( ii )
562  return Track;
563  else
564  return NULL;
565 }
int GetNetCode() const
Function GetNetCode.
EDA_ITEM * Pnext
next in linked list
Definition: base_struct.h:175
const wxPoint& TRACK::GetEndPoint ( ENDPOINT_T  aEndPoint) const
inlineinherited

Return the selected endpoint (start or end)

Definition at line 126 of file class_track.h.

References ENDPOINT_START, TRACK::GetBoundingBox(), TRACK::m_End, and TRACK::m_Start.

Referenced by BOARD::GetPad(), TRACK::GetTrack(), and TRACKS_CLEANER::testTrackEndpointDangling().

127  {
128  if( aEndPoint == ENDPOINT_START )
129  return m_Start;
130  else
131  return m_End;
132  }
wxPoint m_Start
Line start point.
Definition: class_track.h:342
wxPoint m_End
Line end point.
Definition: class_track.h:343
int TRACK::GetEndSegments ( int  NbSegm,
TRACK **  StartTrack,
TRACK **  EndTrack 
)
inherited

Function GetEndSegments get the segments connected to the end point of the track.

return 1 if OK, 0 when a track is a closed loop and the beginning and the end of the track in *StartTrack and *EndTrack Modify *StartTrack en *EndTrack : (*StartTrack)->m_Start coordinate is the beginning of the track (*EndTrack)->m_End coordinate is the end of the track Segments connected must be consecutive in list

Definition at line 1486 of file class_track.cpp.

References BEGIN_ONPAD, BUSY, END_ONPAD, BOARD_ITEM::GetLayerSet(), EDA_ITEM::GetState(), TRACK::GetTrack(), TRACK::GetVia(), TRACK::m_End, TRACK::m_Param, TRACK::m_Start, TRACK::Next(), PCB_VIA_T, and EDA_ITEM::SetState().

Referenced by PCB_EDIT_FRAME::EraseRedundantTrack(), and TRACK::GetLength().

1487 {
1488  TRACK* Track, * via, * segm, * TrackListEnd;
1489  int NbEnds, ii, ok = 0;
1490  LSET layerMask;
1491 
1492  if( aCount <= 1 )
1493  {
1494  *aStartTrace = *aEndTrace = this;
1495  return 1;
1496  }
1497 
1498  // Calculation of the limit analysis.
1499  *aStartTrace = *aEndTrace = NULL;
1500  TrackListEnd = Track = this;
1501  ii = 0;
1502 
1503  for( ; ( Track != NULL ) && ( ii < aCount ); ii++, Track = Track->Next() )
1504  {
1505  TrackListEnd = Track;
1506  Track->m_Param = 0;
1507  }
1508 
1509  // Calculate the extremes.
1510  NbEnds = 0;
1511  Track = this;
1512  ii = 0;
1513 
1514  for( ; ( Track != NULL ) && ( ii < aCount ); ii++, Track = Track->Next() )
1515  {
1516  if( Track->Type() == PCB_VIA_T )
1517  continue;
1518 
1519  layerMask = Track->GetLayerSet();
1520  via = GetVia( TrackListEnd, Track->m_Start, layerMask );
1521 
1522  if( via )
1523  {
1524  layerMask |= via->GetLayerSet();
1525  via->SetState( BUSY, true );
1526  }
1527 
1528  Track->SetState( BUSY, true );
1529  segm = ::GetTrack( this, TrackListEnd, Track->m_Start, layerMask );
1530  Track->SetState( BUSY, false );
1531 
1532  if( via )
1533  via->SetState( BUSY, false );
1534 
1535  if( segm == NULL )
1536  {
1537  switch( NbEnds )
1538  {
1539  case 0:
1540  *aStartTrace = Track; NbEnds++;
1541  break;
1542 
1543  case 1:
1544  int BeginPad, EndPad;
1545  *aEndTrace = Track;
1546 
1547  // Swap ox, oy with fx, fy
1548  BeginPad = Track->GetState( BEGIN_ONPAD );
1549  EndPad = Track->GetState( END_ONPAD );
1550 
1551  Track->SetState( BEGIN_ONPAD | END_ONPAD, false );
1552 
1553  if( BeginPad )
1554  Track->SetState( END_ONPAD, true );
1555 
1556  if( EndPad )
1557  Track->SetState( BEGIN_ONPAD, true );
1558 
1559  std::swap( Track->m_Start, Track->m_End );
1560  std::swap( Track->start, Track->end );
1561  ok = 1;
1562  return ok;
1563  }
1564  }
1565 
1566  layerMask = Track->GetLayerSet();
1567  via = GetVia( TrackListEnd, Track->m_End, layerMask );
1568 
1569  if( via )
1570  {
1571  layerMask |= via->GetLayerSet();
1572  via->SetState( BUSY, true );
1573  }
1574 
1575  Track->SetState( BUSY, true );
1576  segm = ::GetTrack( this, TrackListEnd, Track->m_End, layerMask );
1577  Track->SetState( BUSY, false );
1578 
1579  if( via )
1580  via->SetState( BUSY, false );
1581 
1582  if( segm == NULL )
1583  {
1584  switch( NbEnds )
1585  {
1586  case 0:
1587  int BeginPad, EndPad;
1588  *aStartTrace = Track;
1589  NbEnds++;
1590 
1591  // Swap ox, oy with fx, fy
1592  BeginPad = Track->GetState( BEGIN_ONPAD );
1593  EndPad = Track->GetState( END_ONPAD );
1594 
1595  Track->SetState( BEGIN_ONPAD | END_ONPAD, false );
1596 
1597  if( BeginPad )
1598  Track->SetState( END_ONPAD, true );
1599 
1600  if( EndPad )
1601  Track->SetState( BEGIN_ONPAD, true );
1602 
1603  std::swap( Track->m_Start, Track->m_End );
1604  std::swap( Track->start, Track->end );
1605  break;
1606 
1607  case 1:
1608  *aEndTrace = Track;
1609  ok = 1;
1610  return ok;
1611  }
1612  }
1613  }
1614 
1615  return ok;
1616 }
TRACK * GetTrack(TRACK *aStartTrace, TRACK *aEndTrace, ENDPOINT_T aEndPoint, bool aSameNetOnly, bool aSequential)
Function GetTrack returns the trace segment connected to the segment at aEndPoint from aStartTrace to...
wxPoint m_Start
Line start point.
Definition: class_track.h:342
#define END_ONPAD
Pcbnew: flag set for track segment ending on a pad.
Definition: base_struct.h:129
#define BUSY
Pcbnew: flag indicating that the structure has.
Definition: base_struct.h:130
#define BEGIN_ONPAD
Pcbnew: flag set for track segment starting on a pad.
Definition: base_struct.h:128
double m_Param
Definition: class_track.h:93
VIA * GetVia(const wxPoint &aPosition, PCB_LAYER_ID aLayer=UNDEFINED_LAYER)
Function GetVia finds the first VIA object at aPosition on aLayer starting at the trace...
Class LSET is a set of PCB_LAYER_IDs.
wxPoint m_End
Line end point.
Definition: class_track.h:343
virtual LSET GetLayerSet() const
Function GetLayerSet returns a "layer mask", which is a bitmap of all layers on which the TRACK segme...
TRACK * Next() const
Definition: class_track.h:99
void SetState(int type, int state)
Definition: base_struct.h:253
class VIA, a via (like a track segment on a copper layer)
Definition: typeinfo.h:96
STATUS_FLAGS EDA_ITEM::GetFlags ( ) const
inlineinherited

Definition at line 266 of file base_struct.h.

References EDA_ITEM::m_Flags.

Referenced by AbortMoveAndEditTarget(), SCH_SCREEN::addConnectedItemsToBlock(), AddMenusForBitmap(), AddMenusForBusEntry(), AddMenusForComponent(), AddMenusForComponentField(), AddMenusForEditComponent(), AddMenusForGLabel(), AddMenusForHierchicalSheet(), AddMenusForHLabel(), AddMenusForLabel(), AddMenusForSheetPin(), AddMenusForText(), SCH_EDIT_FRAME::BeginSegment(), SCH_EDIT_FRAME::ChangeTextOrient(), Collect_TrackSegmentsToDrag(), SCH_EDIT_FRAME::ConvertPart(), SCH_EDIT_FRAME::copyBlockItems(), DIALOG_EDIT_COMPONENT_IN_SCHEMATIC::copyPanelToOptions(), LIB_EDIT_FRAME::copySelectedItems(), LIB_EDIT_FRAME::CreatePin(), PCB_EDIT_FRAME::createPopUpMenuForFootprints(), PCB_EDIT_FRAME::createPopUpMenuForFpPads(), PCB_EDIT_FRAME::createPopUpMenuForFpTexts(), PCB_EDIT_FRAME::createPopUpMenuForTexts(), PCB_EDIT_FRAME::createPopupMenuForTracks(), PCB_EDIT_FRAME::createPopUpMenuForZones(), PCB_EDIT_FRAME::Delete_Segment_Edge(), SCH_EDIT_FRAME::DeleteItem(), SCH_EDIT_FRAME::DeleteItemsInList(), SCH_EDIT_FRAME::DeleteJunction(), BOARD::Draw(), PCB_EDIT_FRAME::Edit_TrackSegm_Width(), SCH_EDIT_FRAME::EditComponentFieldText(), SCH_EDIT_FRAME::EditImage(), PCB_EDIT_FRAME::FlipTextePcb(), LIB_VIEW_FRAME::GeneralControl(), SCH_EDIT_FRAME::GeneralControl(), LIB_EDIT_FRAME::GetComponentFromRedoList(), LIB_EDIT_FRAME::GetComponentFromUndoList(), SCH_SCREEN::GetConnection(), InitialiseDragParameters(), EDA_DRAW_FRAME::isBusy(), Magnetize(), SCH_EDIT_FRAME::MirrorImage(), SCH_EDIT_FRAME::MirrorSheet(), moveBitmap(), SCH_EDIT_FRAME::OnAutoplaceFields(), SCH_EDIT_FRAME::OnConvertTextType(), SCH_EDIT_FRAME::OnCopySchematicItemRequest(), SCH_EDIT_FRAME::OnDragItem(), SCH_EDIT_FRAME::OnEditItem(), LIB_EDIT_FRAME::OnEditPin(), FOOTPRINT_EDIT_FRAME::OnHotKey(), SCH_EDIT_FRAME::OnHotKey(), PCB_EDIT_FRAME::OnHotKey(), PCB_EDIT_FRAME::OnHotkeyBeginRoute(), PCB_EDIT_FRAME::OnHotkeyCopyItem(), PCB_EDIT_FRAME::OnHotkeyDeleteItem(), PCB_EDIT_FRAME::OnHotkeyDuplicateOrArrayItem(), PCB_EDIT_FRAME::OnHotkeyEditItem(), PCB_EDIT_FRAME::OnHotkeyFlipItem(), PCB_EDIT_FRAME::OnHotkeyMoveItem(), PCB_EDIT_FRAME::OnHotkeyPlaceItem(), PCB_EDIT_FRAME::OnHotkeyRotateItem(), FOOTPRINT_EDIT_FRAME::OnLeftClick(), SCH_EDIT_FRAME::OnLeftClick(), PCB_EDIT_FRAME::OnLeftClick(), FOOTPRINT_EDIT_FRAME::OnLeftDClick(), SCH_EDIT_FRAME::OnLeftDClick(), PCB_EDIT_FRAME::OnLeftDClick(), EDA_DRAW_PANEL::OnMouseEvent(), SCH_EDIT_FRAME::OnMoveItem(), DIALOG_EDIT_COMPONENT_IN_SCHEMATIC::OnOKButtonClick(), TARGET_PROPERTIES_DIALOG_EDITOR::OnOkClick(), SCH_EDIT_FRAME::OnOpenLibraryEditor(), SCH_EDIT_FRAME::OnOrient(), FOOTPRINT_EDIT_FRAME::OnRightClick(), GERBVIEW_FRAME::OnRightClick(), SCH_EDIT_FRAME::OnRightClick(), PCB_EDIT_FRAME::OnRightClick(), SCH_EDIT_FRAME::OnRotate(), SCH_EDIT_FRAME::OnSelectUnit(), SCH_EDIT_FRAME::OrientComponent(), PCB_EDIT_FRAME::PlaceTarget(), FOOTPRINT_EDIT_FRAME::PrepareItemForHotkey(), LIB_EDIT_FRAME::Process_Special_Functions(), EDIT_TOOL::Properties(), TRACKS_CLEANER::removeDuplicatesOfTrack(), PCB_BASE_FRAME::Rotate_Module(), PCB_EDIT_FRAME::Rotate_Texte_Pcb(), SCH_EDIT_FRAME::RotateField(), SCH_EDIT_FRAME::RotateHierarchicalSheet(), SCH_EDIT_FRAME::RotateImage(), PCB_BASE_FRAME::RotateTextModule(), LIB_EDIT_FRAME::SaveCopyInUndoList(), SCH_EDIT_FRAME::SaveCopyInUndoList(), SCH_EDIT_FRAME::SchematicCleanUp(), SCH_SCREEN::SelectBlockItems(), SCH_EDIT_FRAME::SetBusEntryShape(), DIALOG_EDIT_COMPONENT_IN_SCHEMATIC::SetInitCmp(), Show_Drag_Track_Segment_With_Cte_Slope(), Show_MoveNode(), PCB_EDIT_FRAME::Start_DragTrackSegmentAndKeepSlope(), PCB_EDIT_FRAME::StartMoveOneNodeOrSegment(), DIALOG_LABEL_EDITOR::TextPropertiesAccept(), DIALOG_PCB_TEXT_PROPERTIES::TransferDataFromWindow(), and DIALOG_FOOTPRINT_BOARD_EDITOR::TransferDataFromWindow().

266 { return m_Flags; }
STATUS_FLAGS m_Flags
Flag bits for editing and other uses.
Definition: base_struct.h:186
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 124 of file class_board_item.h.

References BOARD_ITEM::m_Layer.

Referenced by Abort_MoveOrCopyModule(), DIALOG_GLOBAL_DELETION::AcceptPcbDelete(), CINFO3D_VISU::AddGraphicsShapesWithClearanceToContainer(), DIMENSION::AdjustDimensionDetails(), PCB_EDIT_FRAME::Begin_DrawSegment(), GRID_HELPER::BestSnapAnchor(), PCB_EDIT_FRAME::Change_Side_Module(), checkConnectedTo(), MODULE::CopyNetlistSettings(), CreateBoardSection(), MWAVE::CreateMicrowaveInductor(), CreateRoutesSection(), DIALOG_DIMENSION_EDITOR::DIALOG_DIMENSION_EDITOR(), 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(), export_vrml_drawsegment(), export_vrml_edge_module(), export_vrml_module(), export_vrml_pcbtext(), export_vrml_text_module(), PCB_EDIT_FRAME::ExportToGenCAD(), PCB_TARGET::Flip(), EDGE_MODULE::Flip(), TEXTE_PCB::Flip(), TEXTE_MODULE::Flip(), TRACK::Flip(), DIMENSION::Flip(), DRAWSEGMENT::Flip(), MODULE::Flip(), FootprintWriteShape(), PCB_IO::formatLayer(), DSN::SPECCTRA_DB::FromBOARD(), genModuleOnRoutingMatrix(), genPlacementRoutingMatrix(), BOARD::GetFootprint(), ZONE_CONTAINER::GetLayer(), getOptimalModulePlacement(), BOARD::GetPad(), BOARD::GetVisibleTrack(), SELECTION_TOOL::guessSelectionCandidates(), idf_export_module(), DIALOG_FOOTPRINT_BOARD_EDITOR::InitBoardProperties(), GENERAL_COLLECTOR::Inspect(), PCB_LAYER_COLLECTOR::Inspect(), D_PAD::IsFlipped(), EDGE_MODULE::IsParentFlipped(), TEXTE_MODULE::IsParentFlipped(), itemIsIncludedByFilter(), FOOTPRINT_EDIT_FRAME::Load_Module_From_BOARD(), BOARD::MarkTrace(), PCB_EDIT_FRAME::OnRightClick(), PlaceCells(), 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(), Print_Module(), TRACKS_CLEANER::removeDuplicatesOfTrack(), SELECTION_TOOL::selectable(), ShowClearance(), PCB_EDIT_FRAME::Swap_Layers(), PNS_KICAD_IFACE::syncGraphicalItem(), PNS_KICAD_IFACE::syncTrack(), TEXTE_MODULE::TEXTE_MODULE(), TraceSegmentPcb(), TrackListSortByNetcode(), DIALOG_EDIT_FPTEXT::TransferDataFromWindow(), DIALOG_GRAPHIC_ITEM_PROPERTIES::TransferDataFromWindow(), DIALOG_FOOTPRINT_BOARD_EDITOR::TransferDataFromWindow(), DIALOG_EDIT_FPTEXT::TransferDataToWindow(), DIALOG_PCB_TEXT_PROPERTIES::TransferDataToWindow(), DIALOG_MODEDIT_FP_BODY_ITEM_PROPERTIES::TransferDataToWindow(), DIALOG_GRAPHIC_ITEM_PROPERTIES::TransferDataToWindow(), CINFO3D_VISU::transformGraphicModuleEdgeToPolygonSet(), MODULE::TransformGraphicShapesWithClearanceToPolygonSet(), MODULE::TransformGraphicTextWithClearanceToPolygonSet(), TstModuleOnBoard(), TEXTE_MODULE::ViewGetLayers(), TRACK::ViewGetLayers(), and TEXTE_MODULE::ViewGetLOD().

124 { return m_Layer; }
PCB_LAYER_ID m_Layer
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.

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

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

79 {
80  BOARD* board = GetBoard();
81 
82  if( board )
83  return board->GetLayerName( m_Layer );
84 
85  // If no parent, return standard name
87 }
PCB_LAYER_ID m_Layer
const wxString GetLayerName(PCB_LAYER_ID aLayer) const
Function GetLayerName returns the name of a layer given by aLayer.
Class BOARD holds information pertinent to a Pcbnew printed circuit board.
Definition: class_board.h:169
virtual BOARD * GetBoard() const
Function GetBoard returns the BOARD in which this BOARD_ITEM resides, or NULL if none.
static wxString GetStandardLayerName(PCB_LAYER_ID aLayerId)
Function GetStandardLayerName returns an "English Standard" name of a PCB layer when given aLayerNumb...
Definition: class_board.h:650
LSET VIA::GetLayerSet ( ) const
overridevirtual

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

Definition at line 391 of file class_track.cpp.

References LSET::AllCuMask(), GetViaType(), m_BottomLayer, BOARD_ITEM::m_Layer, and VIA_THROUGH.

Referenced by CreatePadsShapesSection(), CreateRoutesSection(), Draw(), DRAWING_TOOL::DrawVia(), TRACK::GetTrack(), BOARD::MarkTrace(), PlotSolderMaskLayer(), PlotStandardLayer(), SELECTION_TOOL::selectable(), ViaSort(), and ViewGetLOD().

392 {
393  if( GetViaType() == VIA_THROUGH )
394  return LSET::AllCuMask();
395 
396  // VIA_BLIND_BURIED or VIA_MICRVIA:
397 
398  LSET layermask;
399 
400  wxASSERT( m_Layer <= m_BottomLayer );
401 
402  // PCB_LAYER_IDs are numbered from front to back, this is top to bottom.
403  for( LAYER_NUM id = m_Layer; id <= m_BottomLayer; ++id )
404  {
405  layermask.set( id );
406  }
407 
408  return layermask;
409 }
static LSET AllCuMask(int aCuLayerCount=MAX_CU_LAYERS)
Function AllCuMask returns a mask holding the requested number of Cu PCB_LAYER_IDs.
Definition: lset.cpp:673
PCB_LAYER_ID m_Layer
Class LSET is a set of PCB_LAYER_IDs.
VIATYPE_T GetViaType() const
Definition: class_track.h:460
PCB_LAYER_ID m_BottomLayer
The bottom layer of the via (the top layer is in m_Layer)
Definition: class_track.h:504
int LAYER_NUM
Type LAYER_NUM can be replaced with int and removed.
double TRACK::GetLength ( ) const
inlineinherited

Function GetLength returns the length of the track using the hypotenuse calculation.

Returns
double - the length of the track

Definition at line 175 of file class_track.h.

References TRACK::Draw(), TRACK::GetEndSegments(), GetLineLength(), TRACK::GetMsgPanelInfo(), TRACK::GetTrack(), TRACK::GetVia(), TRACK::HitTest(), TRACK::IsNull(), TRACK::IsPointOnEnds(), TRACK::m_End, TRACK::m_Start, TRACK::ShowWidth(), TRACK::TransformShapeWithClearanceToPolygon(), UNDEFINED_LAYER, TRACK::Visit(), and BOARD_ITEM::ZeroOffset.

Referenced by calcArea(), TRACK::GetMsgPanelInfoBase(), SEGZONE::GetMsgPanelInfoBase(), and TRACK::GetSelectMenuText().

176  {
177  return GetLineLength( m_Start, m_End );
178  }
wxPoint m_Start
Line start point.
Definition: class_track.h:342
double GetLineLength(const wxPoint &aPointA, const wxPoint &aPointB)
Function GetLineLength returns the length of a line segment defined by aPointA and aPointB...
Definition: trigo.h:191
wxPoint m_End
Line end point.
Definition: class_track.h:343
DHEAD* EDA_ITEM::GetList ( ) const
inlineinherited
bool BOARD_CONNECTED_ITEM::GetLocalRatsnestVisible ( ) const
inlineinherited

Definition at line 168 of file board_connected_item.h.

References BOARD_CONNECTED_ITEM::m_localRatsnestVisible.

169  {
170  return m_localRatsnestVisible;
171  }
BITMAP_DEF VIA::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 TRACK.

Definition at line 220 of file class_track.cpp.

221 {
222  return via_xpm;
223 }
void TRACK::GetMsgPanelInfo ( std::vector< MSG_PANEL_ITEM > &  aList)
overridevirtualinherited

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
aListis the list to populate.

Reimplemented from EDA_ITEM.

Definition at line 1072 of file class_track.cpp.

References TRACK::Back(), CoordinateToString(), DARKCYAN, DARKMAGENTA, BOARD_ITEM::GetBoard(), GetMsgPanelInfoBase(), BOARD_CONNECTED_ITEM::GetNetClass(), LengthDoubleToString(), and BOARD::MarkTrace().

Referenced by PCB_EDIT_FRAME::Attribut_Segment(), and TRACK::GetLength().

1073 {
1074  wxString msg;
1075  BOARD* board = GetBoard();
1076 
1077  // Display basic infos
1078  GetMsgPanelInfoBase( aList );
1079 
1080  // Display full track length (in Pcbnew)
1081  if( board )
1082  {
1083  double trackLen = 0;
1084  double lenPadToDie = 0;
1085 
1086  // Find the beginning of the track buffer containing this, because it is not
1087  // always the track list on board, but can be a "private" list
1088  TRACK* track_buffer_start = this;
1089 
1090  while( track_buffer_start->Back() )
1091  track_buffer_start = track_buffer_start->Back();
1092 
1093  board->MarkTrace( track_buffer_start, this, NULL, &trackLen, &lenPadToDie, false );
1094  msg = ::LengthDoubleToString( trackLen );
1095  aList.push_back( MSG_PANEL_ITEM( _( "Length" ), msg, DARKCYAN ) );
1096 
1097  if( lenPadToDie != 0 )
1098  {
1099  msg = ::LengthDoubleToString( trackLen + lenPadToDie );
1100  aList.push_back( MSG_PANEL_ITEM( _( "Full Length" ), msg, DARKCYAN ) );
1101 
1102  msg = ::LengthDoubleToString( lenPadToDie );
1103  aList.push_back( MSG_PANEL_ITEM( _( "Pad To Die Length" ), msg, DARKCYAN ) );
1104  }
1105  }
1106 
1107  NETCLASSPTR netclass = GetNetClass();
1108 
1109  if( netclass )
1110  {
1111  aList.push_back( MSG_PANEL_ITEM( _( "NC Name" ), netclass->GetName(), DARKMAGENTA ) );
1112  aList.push_back( MSG_PANEL_ITEM( _( "NC Clearance" ),
1113  ::CoordinateToString( netclass->GetClearance(), true ),
1114  DARKMAGENTA ) );
1115  aList.push_back( MSG_PANEL_ITEM( _( "NC Width" ),
1116  ::CoordinateToString( netclass->GetTrackWidth(), true ),
1117  DARKMAGENTA ) );
1118  aList.push_back( MSG_PANEL_ITEM( _( "NC Via Size" ),
1119  ::CoordinateToString( netclass->GetViaDiameter(), true ),
1120  DARKMAGENTA ) );
1121  aList.push_back( MSG_PANEL_ITEM( _( "NC Via Drill"),
1122  ::CoordinateToString( netclass->GetViaDrill(), true ),
1123  DARKMAGENTA ) );
1124  }
1125 }
wxString CoordinateToString(int aValue, bool aConvertToMils)
Function CoordinateToString is a helper to convert the integer coordinate aValue to a string in inche...
Definition: base_units.cpp:118
TRACK * Back() const
Definition: class_track.h:100
std::shared_ptr< NETCLASS > GetNetClass() const
Function GetNetClass returns the NETCLASS for this item.
wxString LengthDoubleToString(double aValue, bool aConvertToMils)
Function LengthDoubleToString is a helper to convert the double length aValue to a string in inches...
Definition: base_units.cpp:123
Class BOARD holds information pertinent to a Pcbnew printed circuit board.
Definition: class_board.h:169
virtual void GetMsgPanelInfoBase(std::vector< MSG_PANEL_ITEM > &aList)
Function GetMsgPanelInfoBase Display info about the track segment only, and does not calculate the fu...
virtual BOARD * GetBoard() const
Function GetBoard returns the BOARD in which this BOARD_ITEM resides, or NULL if none.
Class EDA_MSG_ITEM is used EDA_MSG_PANEL as the item type for displaying messages.
Definition: msgpanel.h:53
TRACK * MarkTrace(TRACK *aTrackList, TRACK *aTrace, int *aCount, double *aTraceLength, double *aInPackageLength, bool aReorder)
Function MarkTrace marks a chain of trace segments, connected to aTrace.
void VIA::GetMsgPanelInfoBase ( std::vector< MSG_PANEL_ITEM > &  aList)
overrideprotectedvirtual

Function GetMsgPanelInfoBase Display info about the track segment only, and does not calculate the full track length.

Parameters
aListA list of MSG_PANEL_ITEM objects to add status information.

Reimplemented from TRACK.

Definition at line 1241 of file class_track.cpp.

References BROWN, CoordinateToString(), DARKCYAN, BOARD_ITEM::GetBoard(), GetDrillValue(), BOARD::GetLayerName(), NETINFO_ITEM::GetMicroViaDrillSize(), TRACK::GetMsgPanelInfoBase_Common(), BOARD_CONNECTED_ITEM::GetNet(), NETINFO_ITEM::GetViaDrillSize(), GetViaType(), LayerPair(), TRACK::m_Width, RED, VIA_BLIND_BURIED, VIA_MICROVIA, VIA_NOT_DEFINED, and VIA_THROUGH.

Referenced by TRACK::GetMsgPanelInfo().

1242 {
1243  wxString msg;
1244  BOARD* board = GetBoard();
1245 
1246  switch( GetViaType() )
1247  {
1248  default:
1249  case VIA_NOT_DEFINED:
1250  msg = wxT( "???" ); // Not used yet, does not exist currently
1251  break;
1252 
1253  case VIA_MICROVIA:
1254  msg = _( "Micro Via" ); // from external layer (TOP or BOTTOM) from
1255  // the near neighbor inner layer only
1256  break;
1257 
1258  case VIA_BLIND_BURIED:
1259  msg = _( "Blind/Buried Via" ); // from inner or external to inner
1260  // or external layer (no restriction)
1261  break;
1262 
1263  case VIA_THROUGH:
1264  msg = _( "Through Via" ); // Usual via (from TOP to BOTTOM layer only )
1265  break;
1266  }
1267 
1268  aList.push_back( MSG_PANEL_ITEM( _( "Type" ), msg, DARKCYAN ) );
1269 
1270  GetMsgPanelInfoBase_Common( aList );
1271 
1272 
1273  // Display layer pair
1274  PCB_LAYER_ID top_layer, bottom_layer;
1275 
1276  LayerPair( &top_layer, &bottom_layer );
1277 
1278  if( board )
1279  msg = board->GetLayerName( top_layer ) + wxT( "/" )
1280  + board->GetLayerName( bottom_layer );
1281  else
1282  msg.Printf( wxT( "%d/%d" ), top_layer, bottom_layer );
1283 
1284  aList.push_back( MSG_PANEL_ITEM( _( "Layers" ), msg, BROWN ) );
1285 
1286  // Display width
1287  msg = ::CoordinateToString( (unsigned) m_Width );
1288 
1289  // Display diameter value:
1290  aList.push_back( MSG_PANEL_ITEM( _( "Diameter" ), msg, DARKCYAN ) );
1291 
1292  // Display drill value
1293  int drill_value = GetDrillValue();
1294 
1295  msg = ::CoordinateToString( drill_value );
1296 
1297  wxString title = _( "Drill" );
1298  title += wxT( " " );
1299 
1300  bool drl_specific = true;
1301 
1302  if( GetBoard() )
1303  {
1304  NETINFO_ITEM* net = GetNet();
1305  int drill_class_value = 0;
1306 
1307  if( net )
1308  {
1309  if( GetViaType() == VIA_MICROVIA )
1310  drill_class_value = net->GetMicroViaDrillSize();
1311  else
1312  drill_class_value = net->GetViaDrillSize();
1313  }
1314 
1315  drl_specific = drill_value != drill_class_value;
1316  }
1317 
1318 
1319  if( drl_specific )
1320  title += _( "(Specific)" );
1321  else
1322  title += _( "(NetClass)" );
1323 
1324  aList.push_back( MSG_PANEL_ITEM( title, msg, RED ) );
1325 }
wxString CoordinateToString(int aValue, bool aConvertToMils)
Function CoordinateToString is a helper to convert the integer coordinate aValue to a string in inche...
Definition: base_units.cpp:118
int m_Width
Thickness of track, or via diameter.
Definition: class_track.h:341
PCB_LAYER_ID
A quick note on layer IDs:
VIATYPE_T GetViaType() const
Definition: class_track.h:460
const wxString GetLayerName(PCB_LAYER_ID aLayer) const
Function GetLayerName returns the name of a layer given by aLayer.
Definition: colors.h:60
void LayerPair(PCB_LAYER_ID *top_layer, PCB_LAYER_ID *bottom_layer) const
Function LayerPair Return the 2 layers used by the via (the via actually uses all layers between thes...
Class NETINFO_ITEM handles the data for a net.
Definition: netinfo.h:69
int GetDrillValue() const
Function GetDrillValue "calculates" the drill value for vias (m-Drill if > 0, or default drill value ...
Class BOARD holds information pertinent to a Pcbnew printed circuit board.
Definition: class_board.h:169
void GetMsgPanelInfoBase_Common(std::vector< MSG_PANEL_ITEM > &aList)
Helper function for the common panel info.
int GetMicroViaDrillSize()
Function GetViaDrillSize returns the size of via drills used to route this net.
Definition: netinfo.h:182
virtual BOARD * GetBoard() const
Function GetBoard returns the BOARD in which this BOARD_ITEM resides, or NULL if none.
Class EDA_MSG_ITEM is used EDA_MSG_PANEL as the item type for displaying messages.
Definition: msgpanel.h:53
int GetViaDrillSize()
Function GetViaDrillSize returns the size of via drills used to route this net.
Definition: netinfo.h:172
NETINFO_ITEM * GetNet() const
Function GetNet Returns NET_INFO object for a given item.
Definition: colors.h:62
void TRACK::GetMsgPanelInfoBase_Common ( std::vector< MSG_PANEL_ITEM > &  aList)
protectedinherited

Helper function for the common panel info.

Definition at line 1127 of file class_track.cpp.

References BLUE, TRACK::end, BOARD_ITEM::GetBoard(), BOARD_CONNECTED_ITEM::GetNet(), BOARD_CONNECTED_ITEM::GetNetCode(), NETINFO_ITEM::GetNetname(), EDA_ITEM::GetState(), TRACK::m_End, EDA_ITEM::m_Flags, TRACK::m_Start, MAGENTA, RED, TRACK::start, TRACK_AR, TRACK_LOCKED, wxPoint::x, and wxPoint::y.

Referenced by TRACK::GetClass(), TRACK::GetMsgPanelInfoBase(), SEGZONE::GetMsgPanelInfoBase(), and GetMsgPanelInfoBase().

1128 {
1129  wxString msg;
1130 
1131  // Display Net Name
1132  if( GetBoard() )
1133  {
1134  NETINFO_ITEM* net = GetNet();
1135 
1136  if( net )
1137  msg = net->GetNetname();
1138  else
1139  msg = wxT( "<noname>" );
1140 
1141  aList.push_back( MSG_PANEL_ITEM( _( "NetName" ), msg, RED ) );
1142 
1143  // Display net code : (useful in test or debug)
1144  msg.Printf( wxT( "%d" ), GetNetCode() );
1145  aList.push_back( MSG_PANEL_ITEM( _( "NetCode" ), msg, RED ) );
1146  }
1147 
1148 #if defined(DEBUG)
1149 
1150  // Display the flags
1151  msg.Printf( wxT( "0x%08X" ), m_Flags );
1152  aList.push_back( MSG_PANEL_ITEM( wxT( "Flags" ), msg, BLUE ) );
1153 
1154 #if 0
1155  // Display start and end pointers:
1156  msg.Printf( wxT( "%p" ), start );
1157  aList.push_back( MSG_PANEL_ITEM( wxT( "start ptr" ), msg, BLUE ) );
1158  msg.Printf( wxT( "%p" ), end );
1159  aList.push_back( MSG_PANEL_ITEM( wxT( "end ptr" ), msg, BLUE ) );
1160  // Display this ptr
1161  msg.Printf( wxT( "%p" ), this );
1162  aList.push_back( MSG_PANEL_ITEM( wxT( "this" ), msg, BLUE ) );
1163 #endif
1164 
1165 #if 0
1166  // Display start and end positions:
1167  msg.Printf( wxT( "%d %d" ), m_Start.x, m_Start.y );
1168  aList.push_back( MSG_PANEL_ITEM( wxT( "Start pos" ), msg, BLUE ) );
1169  msg.Printf( wxT( "%d %d" ), m_End.x, m_End.y );
1170  aList.push_back( MSG_PANEL_ITEM( wxT( "End pos" ), msg, BLUE ) );
1171 #endif
1172 
1173 #endif // defined(DEBUG)
1174 
1175  // Display the State member
1176  msg = wxT( ". . " );
1177 
1178  if( GetState( TRACK_LOCKED ) )
1179  msg[0] = 'L';
1180 
1181  if( GetState( TRACK_AR ) )
1182  msg[2] = 'A';
1183 
1184  aList.push_back( MSG_PANEL_ITEM( _( "Status" ), msg, MAGENTA ) );
1185 }
Definition: colors.h:57
wxPoint m_Start
Line start point.
Definition: class_track.h:342
Definition: colors.h:61
int GetState(int type) const
Definition: base_struct.h:248
wxPoint m_End
Line end point.
Definition: class_track.h:343
#define TRACK_LOCKED
Pcbnew: track locked: protected from global deletion.
Definition: base_struct.h:124
Definition: colors.h:60
#define TRACK_AR
Pcbnew: autorouted track.
Definition: base_struct.h:125
int GetNetCode() const
Function GetNetCode.
Class NETINFO_ITEM handles the data for a net.
Definition: netinfo.h:69
STATUS_FLAGS m_Flags
Flag bits for editing and other uses.
Definition: base_struct.h:186
virtual BOARD * GetBoard() const
Function GetBoard returns the BOARD in which this BOARD_ITEM resides, or NULL if none.
const wxString & GetNetname() const
Function GetNetname.
Definition: netinfo.h:235
Class EDA_MSG_ITEM is used EDA_MSG_PANEL as the item type for displaying messages.
Definition: msgpanel.h:53
BOARD_CONNECTED_ITEM * end
Definition: class_track.h:91
BOARD_CONNECTED_ITEM * start
Definition: class_track.h:90
NETINFO_ITEM * GetNet() const
Function GetNet Returns NET_INFO object for a given item.
NETCLASSPTR BOARD_CONNECTED_ITEM::GetNetClass ( ) const
inherited

Function GetNetClass returns the NETCLASS for this item.

Definition at line 104 of file board_connected_item.cpp.

References DBG, BOARD::FindNet(), BOARD_ITEM::GetBoard(), BOARD_DESIGN_SETTINGS::GetDefault(), BOARD::GetDesignSettings(), NETINFO_ITEM::GetNetClass(), BOARD_CONNECTED_ITEM::GetNetCode(), and EDA_ITEM::Type().

Referenced by DIALOG_TRACK_VIA_PROPERTIES::Apply(), DRC::doTrackDrc(), BOARD_CONNECTED_ITEM::GetClearance(), ZONE_CONTAINER::GetClearance(), GetDrillValue(), TRACK::GetMsgPanelInfo(), BOARD_CONNECTED_ITEM::GetNetClassName(), BOARD_CONNECTED_ITEM::GetShortNetname(), and ROUTER_TOOL::prepareInteractive().

105 {
106  // It is important that this be implemented without any sequential searching.
107  // Simple array lookups should be fine, performance-wise.
108  BOARD* board = GetBoard();
109 
110  // DO NOT use wxASSERT, because GetNetClass is called inside an OnPaint event
111  // and a call to wxASSERT can crash the application.
112 
113  if( board == NULL ) // Should not occur
114  {
115  DBG(printf( "%s: NULL board,type %d", __func__, Type() );)
116 
117  return NETCLASSPTR();
118  }
119 
120  NETCLASSPTR netclass;
121  NETINFO_ITEM* net = board->FindNet( GetNetCode() );
122 
123  if( net )
124  {
125  netclass = net->GetNetClass();
126 
127  //DBG( if(!netclass) printf( "%s: NULL netclass,type %d", __func__, Type() );)
128  }
129 
130  if( netclass )
131  return netclass;
132  else
133  return board->GetDesignSettings().GetDefault();
134 }
KICAD_T Type() const
Function Type()
Definition: base_struct.h:209
NETCLASSPTR GetDefault() const
Function GetDefault.
BOARD_DESIGN_SETTINGS & GetDesignSettings() const
Function GetDesignSettings.
Definition: class_board.h:535
int GetNetCode() const
Function GetNetCode.
Class NETINFO_ITEM handles the data for a net.
Definition: netinfo.h:69
Class BOARD holds information pertinent to a Pcbnew printed circuit board.
Definition: class_board.h:169
NETCLASSPTR GetNetClass()
Definition: netinfo.h:122
NETINFO_ITEM * FindNet(int aNetcode) const
Function FindNet searches for a net with the given netcode.
virtual BOARD * GetBoard() const
Function GetBoard returns the BOARD in which this BOARD_ITEM resides, or NULL if none.
#define DBG(x)
Definition: fctsys.h:33
wxString BOARD_CONNECTED_ITEM::GetNetClassName ( ) const
inherited

Function GetNetClassName returns a pointer to the netclass of the zone.

If the net is not found (can happen when a netlist is reread, and the net name does not exist, return the default net class (should not return a null pointer).

Returns
the Net Class name of this item

Definition at line 137 of file board_connected_item.cpp.

References NETCLASS::Default, BOARD_CONNECTED_ITEM::GetNetClass(), and name.

Referenced by PCB_EDIT_FRAME::createPopUpMenuForFpPads(), PCB_EDIT_FRAME::createPopupMenuForTracks(), and BOARD_CONNECTED_ITEM::GetShortNetname().

138 {
139  wxString name;
140  NETCLASSPTR myclass = GetNetClass();
141 
142  if( myclass )
143  name = myclass->GetName();
144  else
145  name = NETCLASS::Default;
146 
147  return name;
148 }
std::shared_ptr< NETCLASS > GetNetClass() const
Function GetNetClass returns the NETCLASS for this item.
static const char Default[]
the name of the default NETCLASS
Definition: netclass.h:90
const char * name
Definition: DXF_plotter.cpp:61
int BOARD_CONNECTED_ITEM::GetNetCode ( ) const
inlineinherited

Function GetNetCode.

Returns
int - the net code.

Definition at line 103 of file board_connected_item.h.

References NETINFO_ITEM::GetNet(), BOARD_CONNECTED_ITEM::m_netinfo, and BOARD_CONNECTED_ITEM::SetNetCode().

Referenced by PCB_EDIT_FRAME::Attribut_net(), PCB_EDIT_FRAME::Begin_Route(), PCB_EDIT_FRAME::Begin_Zone(), Build_Work(), ZONE_FILLER::buildUnconnectedThermalStubsPolygonList(), ZONE_FILLER::buildZoneFeatureHoleList(), PCB_EDIT_FRAME::Change_Net_Tracks_And_Vias_Sizes(), Collect_TrackSegmentsToDrag(), BOARD::CombineAllAreasInNet(), ZONE_FILLER::computeRawFilledAreas(), connectedItemFilter(), D_PAD::CopyNetlistSettings(), CreateRoutesSection(), CreateSignalsSection(), PCB_EDIT_FRAME::Delete_net(), PCB_EDIT_FRAME::Delete_Segment(), DRC::doEdgeZoneDrc(), DRC::doPadToPadsDrc(), DRC::doTrackDrc(), KIGFX::PCB_PAINTER::draw(), Draw(), BOARD::DrawHighLight(), TRACK::DrawShortNetname(), DRAWING_TOOL::DrawVia(), PCB_EDIT_FRAME::duplicateZone(), PCB_EDIT_FRAME::End_Zone(), PCB_EDIT_FRAME::EraseRedundantTrack(), PCB_EDIT_FRAME::ExecuteRemoteCommand(), PNS::NODE::FindItemByParent(), PCB_IO::format(), DSN::SPECCTRA_DB::FromBOARD(), TRACK::GetBestInsertPoint(), CONNECTIVITY_DATA::GetConnectedItems(), TRACK::GetEndNetCode(), ZONE_CONTAINER::GetMsgPanelInfo(), TRACK::GetMsgPanelInfoBase_Common(), BOARD_CONNECTED_ITEM::GetNetClass(), TRACK::GetSelectMenuText(), GetSelectMenuText(), ZONE_CONTAINER::GetSelectMenuText(), TRACK::GetStartNetCode(), TRACK::GetTrack(), hash_eda(), highlightNet(), BOARD::HitTestForAnyFilledArea(), ZONE_CONTAINER::IsSame(), LocateIntrusion(), Magnetize(), DSN::SPECCTRA_DB::makeIMAGE(), CONNECTIVITY_DATA::NearestUnconnectedTargets(), ROUTER_TOOL::NeighboringSegmentFilter(), BOARD::NormalizeAreaPolygon(), BOARD::OnAreaPolygonModified(), ZONE_SETTINGS::operator<<(), PlaceCells(), PCB_EDIT_FRAME::PlaceDraggedOrMovedTrackSegment(), PCB_EDIT_FRAME::Process_Special_Functions(), PushTrack(), PCB_EDIT_FRAME::Remove_One_Track(), PCB_EDIT_FRAME::Remove_Zone_Corner(), TRACKS_CLEANER::removeDuplicatesOfTrack(), BOARD::ReplaceNetlist(), PCB_SELECTION_CONDITIONS::sameNetFunc(), SaveCopyOfZones(), BOARD::SetAreasNetCodesFromNetNames(), PCB_EDIT_FRAME::Start_DragTrackSegmentAndKeepSlope(), 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::StartMoveOneNodeOrSegment(), PNS_KICAD_IFACE::syncPad(), PNS_KICAD_IFACE::syncTrack(), PNS_KICAD_IFACE::syncVia(), BOARD::TestAreaIntersections(), DRC::testZones(), DRC::TestZoneToZoneOutline(), TrackListSortByNetcode(), BOARD::TracksInNet(), ZONE_CONTAINER::ZONE_CONTAINER(), and PCB_EDITOR_CONTROL::ZoneMerge().

104  {
105  return m_netinfo->GetNet();
106  }
int GetNet() const
Function GetNet.
Definition: netinfo.h:227
NETINFO_ITEM * m_netinfo
Stores all informations about the net that item belongs to.
int BOARD_ITEM::getNextNumberInSequence ( const std::set< int > &  aSeq,
bool  aFillSequenceGaps 
)
staticprotectedinherited

Definition at line 230 of file class_board_item.cpp.

Referenced by MODULE::GetNextPadName().

231 {
232  if( aSeq.empty() )
233  return 1;
234 
235  // By default go to the end of the sequence
236  int candidate = *aSeq.rbegin();
237 
238  // Filling in gaps in pad numbering
239  if( aFillSequenceGaps )
240  {
241  // start at the beginning
242  candidate = *aSeq.begin();
243 
244  for( auto it : aSeq )
245  {
246  if( it - candidate > 1 )
247  break;
248 
249  candidate = it;
250  }
251  }
252 
253  ++candidate;
254 
255  return candidate;
256 }
BOARD_ITEM_CONTAINER* BOARD_ITEM::GetParent ( void  ) const
inlineinherited

Definition at line 118 of file class_board_item.h.

References EDA_ITEM::m_Parent.

Referenced by Abort_Move_ModuleOutline(), AbortMoveTextModule(), POINT_EDITOR::addCorner(), ALIGN_DISTRIBUTE_TOOL::AlignBottom(), ALIGN_DISTRIBUTE_TOOL::AlignCenterX(), ALIGN_DISTRIBUTE_TOOL::AlignCenterY(), ALIGN_DISTRIBUTE_TOOL::AlignTop(), CmpHoleSorting(), compute_Ratsnest_PlaceModule(), PCB_EDIT_FRAME::createPopUpMenuForFpTexts(), FOOTPRINT_EDIT_FRAME::Delete_Edge_Module(), BOARD_ITEM::DeleteStructure(), PCB_BASE_FRAME::DeleteTextModule(), DIALOG_EDIT_FPTEXT::DIALOG_EDIT_FPTEXT(), ALIGN_DISTRIBUTE_TOOL::doAlignLeft(), ALIGN_DISTRIBUTE_TOOL::doAlignRight(), KIGFX::PCB_PAINTER::draw(), TEXTE_MODULE::DrawUmbilical(), PCB_EDIT_FRAME::duplicateItems(), PCB_IO::format(), FormatProbeItem(), BOARD_ITEM::GetBoard(), EDGE_MODULE::GetMsgPanelInfo(), EDGE_MODULE::GetSelectMenuText(), TEXTE_MODULE::GetSelectMenuText(), TEXTE_MODULE::GetShownText(), SELECTION_TOOL::guessSelectionCandidates(), GENERAL_COLLECTOR::Inspect(), EDGE_MODULE::IsParentFlipped(), TEXTE_MODULE::IsParentFlipped(), LEGACY_PLUGIN::loadMODULE_TEXT(), PCB_EDIT_FRAME::moveExact(), FOOTPRINT_EDIT_FRAME::OnRightClick(), FOOTPRINT_EDIT_FRAME::Place_EdgeMod(), PCB_BASE_FRAME::PlaceTexteModule(), BRDITEMS_PLOTTER::Plot_1_EdgeModule(), BRDITEMS_PLOTTER::PlotTextModule(), PCB_EDIT_FRAME::Process_Special_Functions(), BOARD_COMMIT::Push(), PAD_TOOL::pushPadSettings(), PCB_BASE_FRAME::ResetTextSize(), PCB_BASE_FRAME::RotateTextModule(), PCB_BASE_EDIT_FRAME::SaveCopyInUndoList(), SELECTION_TOOL::select(), ShowCurrentOutlineWhileMoving(), ShowNewEdgeModule(), PCB_BASE_FRAME::StartMoveTexteModule(), and SwapItemData().

118 { return (BOARD_ITEM_CONTAINER*) m_Parent; }
EDA_ITEM * m_Parent
Linked list: Link (parent struct)
Definition: base_struct.h:179
Abstract interface for BOARD_ITEMs capable of storing other items inside.
const wxPoint VIA::GetPosition ( ) const
inlineoverridevirtual
wxString VIA::GetSelectMenuText ( ) 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 TRACK.

Definition at line 173 of file class_track.cpp.

References BOARD_ITEM::GetBoard(), GetChars(), BOARD::GetLayerName(), BOARD_CONNECTED_ITEM::GetNetCode(), BOARD_CONNECTED_ITEM::GetNetname(), GetViaType(), LayerPair(), TRACK::ShowWidth(), VIA_BLIND_BURIED, and VIA_MICROVIA.

Referenced by PCB_IO::format().

174 {
175  wxString text;
176  wxString format;
177  BOARD* board = GetBoard();
178 
179  switch( GetViaType() )
180  {
181  case VIA_BLIND_BURIED:
182  format = _( "Blind/Buried Via %s, net[%s] (%d) on layers %s/%s" );
183  break;
184  case VIA_MICROVIA:
185  format = _( "Micro Via %s, Net [%s] (%d) on layers %s/%s" );
186  break;
187  // else say nothing about normal (through) vias
188  default:
189  format = _( "Via %s net [%s] (%d) on layers %s/%s" );
190  break;
191  }
192 
193 
194  if( board )
195  {
196  wxString netname = GetNetname();
197 
198  // say which layers, only two for now
199  PCB_LAYER_ID topLayer;
200  PCB_LAYER_ID botLayer;
201  LayerPair( &topLayer, &botLayer );
202  text.Printf( format.GetData(), GetChars( ShowWidth() ),
203  GetChars( netname ), GetNetCode(),
204  GetChars( board->GetLayerName( topLayer ) ),
205  GetChars( board->GetLayerName( botLayer ) ) );
206 
207  }
208  else
209  {
210  wxFAIL_MSG( wxT( "VIA::GetSelectMenuText: BOARD is NULL" ) );
211  text.Printf( format.GetData(), GetChars( ShowWidth() ),
212  wxT( "???" ), 0,
213  wxT( "??" ), wxT( "??" ) );
214  }
215 
216  return text;
217 }
PCB_LAYER_ID
A quick note on layer IDs:
VIATYPE_T GetViaType() const
Definition: class_track.h:460
const wxString GetLayerName(PCB_LAYER_ID aLayer) const
Function GetLayerName returns the name of a layer given by aLayer.
void LayerPair(PCB_LAYER_ID *top_layer, PCB_LAYER_ID *bottom_layer) const
Function LayerPair Return the 2 layers used by the via (the via actually uses all layers between thes...
int GetNetCode() const
Function GetNetCode.
wxString ShowWidth() const
Function ShowWidth returns the width of the track in displayable user units.
static const wxChar * GetChars(const wxString &s)
Function GetChars returns a wxChar* to the actual wxChar* data within a wxString, and is helpful for ...
Definition: macros.h:92
const wxString & GetNetname() const
Function GetNetname.
Class BOARD holds information pertinent to a Pcbnew printed circuit board.
Definition: class_board.h:169
virtual BOARD * GetBoard() const
Function GetBoard returns the BOARD in which this BOARD_ITEM resides, or NULL if none.
const wxString& BOARD_CONNECTED_ITEM::GetShortNetname ( ) const
inlineinherited

Function GetShortNetname.

Returns
wxString - the short netname

Definition at line 131 of file board_connected_item.h.

References BOARD_CONNECTED_ITEM::GetClearance(), BOARD_CONNECTED_ITEM::GetNetClass(), BOARD_CONNECTED_ITEM::GetNetClassName(), NETINFO_ITEM::GetShortNetname(), and BOARD_CONNECTED_ITEM::m_netinfo.

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

132  {
133  return m_netinfo->GetShortNetname();
134  }
const wxString & GetShortNetname() const
Function GetShortNetname.
Definition: netinfo.h:241
NETINFO_ITEM * m_netinfo
Stores all informations about the net that item belongs to.
const wxPoint& TRACK::GetStart ( ) const
inlineinherited

Definition at line 122 of file class_track.h.

References TRACK::m_Start.

Referenced by CN_LIST::Add(), PCB_EDIT_FRAME::Add45DegreeSegment(), DIALOG_TRACK_VIA_PROPERTIES::Apply(), BOARD::chainMarkedSegments(), Collect_TrackSegmentsToDrag(), GRID_HELPER::computeAnchors(), ComputeBreakPoint(), CINFO3D_VISU::createLayers(), BOARD::CreateLockPoint(), CINFO3D_VISU::createNewTrack(), CreateRoutesSection(), DIALOG_TRACK_VIA_PROPERTIES::DIALOG_TRACK_VIA_PROPERTIES(), DRC::doTrackDrc(), DRC::doTrackKeepoutDrc(), DRAG_SEGM_PICKER::DRAG_SEGM_PICKER(), KIGFX::PCB_PAINTER::draw(), DRAWING_TOOL::DrawVia(), PCB_EDIT_FRAME::EraseRedundantTrack(), export_vrml_via(), DRC::fillMarker(), find_vias_and_tracks_at(), FindBestGridPointOnTrack(), PCB_IO::format(), DSN::SPECCTRA_DB::FromBOARD(), C3D_RENDER_OGL_LEGACY::generate_3D_Vias_and_Pads(), TRACK::HitTest(), HitTest(), InitialiseDragParameters(), C3D_RENDER_RAYTRACING::insert3DViaHole(), Magnetize(), BOARD::MarkTrace(), TRACKS_CLEANER::mergeCollinearSegmentIfPossible(), ROUTER_TOOL::NeighboringSegmentFilter(), OrCell_Trace(), PCB_EDIT_FRAME::Other_Layer_Route(), otherEnd(), PCB_EDIT_FRAME::PlaceDraggedOrMovedTrackSegment(), BRDITEMS_PLOTTER::PlotDrillMarks(), PlotStandardLayer(), PCB_EDIT_FRAME::PrintPage(), PushTrack(), TRACKS_CLEANER::removeDuplicatesOfTrack(), TRACKS_CLEANER::removeDuplicatesOfVia(), DRAG_SEGM_PICKER::SetAuxParameters(), Show_Drag_Track_Segment_With_Cte_Slope(), Show_MoveNode(), PCB_EDIT_FRAME::Start_DragTrackSegmentAndKeepSlope(), PCB_EDIT_FRAME::StartMoveOneNodeOrSegment(), PNS_KICAD_IFACE::syncTrack(), TRACKS_CLEANER::testTrackEndpointDangling(), TraceSegmentPcb(), updateConn(), and PCB_BRIGHT_BOX::ViewDraw().

122 { return m_Start; }
wxPoint m_Start
Line start point.
Definition: class_track.h:342
TRACK * TRACK::GetStartNetCode ( int  NetCode)
inherited

Definition at line 505 of file class_track.cpp.

References BOARD_CONNECTED_ITEM::GetNetCode(), and EDA_ITEM::Pnext.

Referenced by Collect_TrackSegmentsToDrag(), PCB_EDIT_FRAME::Delete_net(), PCB_EDIT_FRAME::EraseRedundantTrack(), and TRACK::SetLocked().

506 {
507  TRACK* Track = this;
508  int ii = 0;
509 
510  if( NetCode == -1 )
511  NetCode = GetNetCode();
512 
513  while( Track != NULL )
514  {
515  if( Track->GetNetCode() > NetCode )
516  break;
517 
518  if( Track->GetNetCode() == NetCode )
519  {
520  ii++;
521  break;
522  }
523 
524  Track = (TRACK*) Track->Pnext;
525  }
526 
527  if( ii )
528  return Track;
529  else
530  return NULL;
531 }
int GetNetCode() const
Function GetNetCode.
EDA_ITEM * Pnext
next in linked list
Definition: base_struct.h:175
STATUS_FLAGS EDA_ITEM::GetStatus ( ) const
inlineinherited

Definition at line 261 of file base_struct.h.

References EDA_ITEM::m_Status.

Referenced by PCB_IO::format(), and GERBER_DRAW_ITEM::HitTest().

261 { return m_Status; }
STATUS_FLAGS m_Status
Definition: base_struct.h:172
TRACK * TRACK::GetTrack ( TRACK aStartTrace,
TRACK aEndTrace,
ENDPOINT_T  aEndPoint,
bool  aSameNetOnly,
bool  aSequential 
)
inherited

Function GetTrack returns the trace segment connected to the segment at aEndPoint from aStartTrace to aEndTrace.

Parameters
aStartTraceA pointer to the TRACK object to begin searching.
aEndTraceA pointer to the TRACK object to stop the search. A NULL value searches to the end of the list.
aEndPointThe start or end point of the segment to test against.
aSameNetOnlyif true stop searching when the netcode changes
aSequentialIf true, forces a forward sequential search, which is restartable; the default search can be faster but the position of the returned track in the list is unpredictable
Returns
A TRACK object pointer if found otherwise NULL.

Definition at line 1408 of file class_track.cpp.

References TRACK::Back(), BUSY, TRACK::GetEndPoint(), BOARD_ITEM::GetLayerSet(), GetLayerSet(), BOARD_CONNECTED_ITEM::GetNetCode(), EDA_ITEM::GetState(), IS_DELETED, TRACK::m_End, TRACK::m_Start, and TRACK::Next().

Referenced by TRACK::GetEndSegments(), TRACK::GetLength(), TRACKS_CLEANER::MergeCollinearTracks(), and PCB_EDIT_FRAME::Start_DragTrackSegmentAndKeepSlope().

1410 {
1411  const wxPoint& position = GetEndPoint( aEndPoint );
1412  LSET refLayers = GetLayerSet();
1413  TRACK* previousSegment;
1414  TRACK* nextSegment;
1415 
1416  if( aSequential )
1417  {
1418  // Simple sequential search: from aStartTrace forward to aEndTrace
1419  previousSegment = NULL;
1420  nextSegment = aStartTrace;
1421  }
1422  else
1423  {
1424  /* Local bidirectional search: from this backward to aStartTrace
1425  * AND forward to aEndTrace. The idea is that nearest segments
1426  * are found (on average) faster in this way. In fact same-net
1427  * segments are almost guaranteed to be found faster, in a global
1428  * search, since they are grouped together in the track list */
1429  previousSegment = this;
1430  nextSegment = this;
1431  }
1432 
1433  while( nextSegment || previousSegment )
1434  {
1435  // Terminate the search in the direction if the netcode mis-matches
1436  if( aSameNetOnly )
1437  {
1438  if( nextSegment && (nextSegment->GetNetCode() != GetNetCode()) )
1439  nextSegment = NULL;
1440  if( previousSegment && (previousSegment->GetNetCode() != GetNetCode()) )
1441  previousSegment = NULL;
1442  }
1443 
1444  if( nextSegment )
1445  {
1446  if ( (nextSegment != this) &&
1447  !nextSegment->GetState( BUSY | IS_DELETED ) &&
1448  ( refLayers & nextSegment->GetLayerSet() ).any() )
1449  {
1450  if( (position == nextSegment->m_Start) ||
1451  (position == nextSegment->m_End) )
1452  return nextSegment;
1453  }
1454 
1455  // Keep looking forward
1456  if( nextSegment == aEndTrace )
1457  nextSegment = NULL;
1458  else
1459  nextSegment = nextSegment->Next();
1460  }
1461 
1462  // Same as above, looking back. During sequential search this branch is inactive
1463  if( previousSegment )
1464  {
1465  if( (previousSegment != this) &&
1466  !previousSegment->GetState( BUSY | IS_DELETED ) &&
1467  ( refLayers & previousSegment->GetLayerSet() ).any()
1468  )
1469  {
1470  if( (position == previousSegment->m_Start) ||
1471  (position == previousSegment->m_End) )
1472  return previousSegment;
1473  }
1474 
1475  if( previousSegment == aStartTrace )
1476  previousSegment = NULL;
1477  else
1478  previousSegment = previousSegment->Back();
1479  }
1480  }
1481 
1482  return NULL;
1483 }
wxPoint m_Start
Line start point.
Definition: class_track.h:342
#define BUSY
Pcbnew: flag indicating that the structure has.
Definition: base_struct.h:130
int GetState(int type) const
Definition: base_struct.h:248
TRACK * Back() const
Definition: class_track.h:100
Class LSET is a set of PCB_LAYER_IDs.
#define IS_DELETED
Definition: base_struct.h:112
wxPoint m_End
Line end point.
Definition: class_track.h:343
const wxPoint & GetEndPoint(ENDPOINT_T aEndPoint) const
Return the selected endpoint (start or end)
Definition: class_track.h:126
virtual LSET GetLayerSet() const
Function GetLayerSet returns a "layer mask", which is a bitmap of all layers on which the TRACK segme...
int GetNetCode() const
Function GetNetCode.
TRACK * Next() const
Definition: class_track.h:99
int BOARD_ITEM::getTrailingInt ( const wxString &  aStr)
staticprotectedinherited

Definition at line 207 of file class_board_item.cpp.

Referenced by MODULE::GetNextPadName().

208 {
209  int number = 0;
210  int base = 1;
211 
212  // Trim and extract the trailing numeric part
213  int index = aStr.Len() - 1;
214  while( index >= 0 )
215  {
216  const char chr = aStr.GetChar( index );
217 
218  if( chr < '0' || chr > '9' )
219  break;
220 
221  number += ( chr - '0' ) * base;
222  base *= 10;
223  index--;
224  }
225 
226  return number;
227 }
VIA * TRACK::GetVia ( const wxPoint aPosition,
PCB_LAYER_ID  aLayer = UNDEFINED_LAYER 
)
inherited

Function GetVia finds the first VIA object at aPosition on aLayer starting at the trace.

Parameters
aPositionThe wxPoint to HitTest() against.
aLayerThe layer to match, pass -1 for a don't care.
Returns
A pointer to a VIA object if found, else NULL.

Definition at line 1377 of file class_track.cpp.

References BUSY, GetFirstVia(), IS_DELETED, and UNDEFINED_LAYER.

Referenced by BOARD::chainMarkedSegments(), PCB_EDIT_FRAME::EraseRedundantTrack(), TRACK::GetEndSegments(), and TRACK::GetLength().

1378 {
1379  for( VIA* via = GetFirstVia( this ); via; via = GetFirstVia( via->Next() ) )
1380  {
1381  if( via->HitTest( aPosition ) &&
1382  !via->GetState( BUSY | IS_DELETED ) &&
1383  ((aLayer == UNDEFINED_LAYER) || (via->IsOnLayer( aLayer ))) )
1384  return via;
1385  }
1386 
1387  return NULL;
1388 }
#define BUSY
Pcbnew: flag indicating that the structure has.
Definition: base_struct.h:130
#define IS_DELETED
Definition: base_struct.h:112
VIA * GetFirstVia(TRACK *aTrk, const TRACK *aStopPoint=NULL)
Scan a track list for the first VIA o NULL if not found (or NULL passed)
Definition: class_track.h:513
VIA * TRACK::GetVia ( TRACK aEndTrace,
const wxPoint aPosition,
LSET  aLayerMask 
)
inherited

Function GetVia finds the first VIA object at aPosition on aLayer starting at the trace and ending at aEndTrace.

Parameters
aEndTracePointer to the last TRACK object to end search.
aPositionThe wxPoint to HitTest() against.
aLayerMaskThe layers to match, pass -1 for a don't care.
Returns
A pointer to a VIA object if found, else NULL.

Definition at line 1391 of file class_track.cpp.

References BUSY, GetFirstVia(), and IS_DELETED.

1392 {
1393  for( VIA* via = GetFirstVia( this, aEndTrace ); via; via = GetFirstVia( via->Next() ) )
1394  {
1395  if( via->HitTest( aPosition ) &&
1396  !via->GetState( BUSY | IS_DELETED ) &&
1397  ( aLayerMask & via->GetLayerSet() ).any()
1398  )
1399  {
1400  return via;
1401  }
1402  }
1403 
1404  return NULL;
1405 }
#define BUSY
Pcbnew: flag indicating that the structure has.
Definition: base_struct.h:130
#define IS_DELETED
Definition: base_struct.h:112
VIA * GetFirstVia(TRACK *aTrk, const TRACK *aStopPoint=NULL)
Scan a track list for the first VIA o NULL if not found (or NULL passed)
Definition: class_track.h:513
bool VIA::HitTest ( const wxPoint aPosition) const
overridevirtual

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

Parameters
aPositionA reference to a wxPoint object containing the coordinates to test.
Returns
True if aPosition is within or on the item bounding area.

Reimplemented from TRACK.

Definition at line 1333 of file class_track.cpp.

References dist, TRACK::m_Start, TRACK::m_Width, wxPoint::x, and wxPoint::y.

1334 {
1335  int max_dist = m_Width / 2;
1336 
1337  // rel_pos is aPosition relative to m_Start (or the center of the via)
1338  wxPoint rel_pos = aPosition - m_Start;
1339  double dist = (double) rel_pos.x * rel_pos.x + (double) rel_pos.y * rel_pos.y;
1340  return dist <= (double) max_dist * max_dist;
1341 }
wxPoint m_Start
Line start point.
Definition: class_track.h:342
static const int dist[10][10]
Definition: dist.cpp:57
int m_Width
Thickness of track, or via diameter.
Definition: class_track.h:341
bool VIA::HitTest ( const EDA_RECT aRect,
bool  aContained = true,
int  aAccuracy = 0 
) const
overridevirtual

Function HitTest tests if the aRect intersects or contains this object (depending on aContained).

Parameters
aRectA reference to an EDA_RECT object containg the area to test.
aContainedTest if aRect contains this object completly.
aAccuracyIncrease 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 TRACK.

Definition at line 1357 of file class_track.cpp.

References EDA_RECT::Contains(), TRACK::GetStart(), TRACK::GetWidth(), EDA_RECT::Inflate(), EDA_RECT::IntersectsCircle(), and EDA_RECT::SetOrigin().

1358 {
1359  EDA_RECT box;
1360  EDA_RECT arect = aRect;
1361  arect.Inflate( aAccuracy );
1362 
1363  box.SetOrigin( GetStart() );
1364  box.Inflate( GetWidth() / 2 );
1365 
1366  if( aContained )
1367  {
1368  return arect.Contains( box );
1369  }
1370  else
1371  {
1372  return arect.IntersectsCircle( GetStart(), GetWidth() / 2 );
1373  }
1374 }
bool Contains(const wxPoint &aPoint) const
Function Contains.
bool IntersectsCircle(const wxPoint &aCenter, const int aRadius) const
Function IntersectsCircle tests for a common area between a circle and this rectangle.
void SetOrigin(const wxPoint &pos)
Definition: eda_rect.h:124
const wxPoint & GetStart() const
Definition: class_track.h:122
int GetWidth() const
Definition: class_track.h:116
Class EDA_RECT handles the component boundary box.
Definition: eda_rect.h:44
EDA_RECT & Inflate(wxCoord dx, wxCoord dy)
Function Inflate inflates the rectangle horizontally by dx and vertically by dy.
bool EDA_ITEM::IsBrightened ( ) const
inlineinherited

Definition at line 235 of file base_struct.h.

References BRIGHTENED.

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

235 { return m_Flags & BRIGHTENED; }
#define BRIGHTENED
item is drawn with a bright contour
Definition: base_struct.h:133
STATUS_FLAGS m_Flags
Flag bits for editing and other uses.
Definition: base_struct.h:186
bool BOARD_CONNECTED_ITEM::IsConnected ( ) const
inlineoverridevirtualinherited

>

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

Definition at line 75 of file board_connected_item.h.

76  {
77  return true;
78  }
bool EDA_ITEM::IsDragging ( ) const
inlineinherited
bool VIA::IsDrillDefault ( ) const
inline

Function IsDrillDefault.

Returns
true if the drill value is default value (-1)

Definition at line 495 of file class_track.h.

References TRACK::GetMsgPanelInfoBase(), and TRACK::SwapData().

495 { return m_Drill <= 0; }
int m_Drill
Definition: class_track.h:508
bool EDA_ITEM::IsHighlighted ( ) const
inlineinherited

Definition at line 234 of file base_struct.h.

References HIGHLIGHTED.

234 { return m_Flags & HIGHLIGHTED; }
#define HIGHLIGHTED
item is drawn in normal colors, when the rest is darkened
Definition: base_struct.h:132
STATUS_FLAGS m_Flags
Flag bits for editing and other uses.
Definition: base_struct.h:186
bool TRACK::IsLocked ( ) const
inlineoverridevirtualinherited

Function IsLocked.

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

Reimplemented from BOARD_ITEM.

Definition at line 137 of file class_track.h.

References EDA_ITEM::GetState(), and TRACK_LOCKED.

Referenced by DIALOG_TRACK_VIA_PROPERTIES::DIALOG_TRACK_VIA_PROPERTIES(), PNS_KICAD_IFACE::syncTrack(), and PNS_KICAD_IFACE::syncVia().

138  {
139  return GetState( TRACK_LOCKED );
140  }
int GetState(int type) const
Definition: base_struct.h:248
#define TRACK_LOCKED
Pcbnew: track locked: protected from global deletion.
Definition: base_struct.h:124
bool EDA_ITEM::IsModified ( ) const
inlineinherited

Definition at line 228 of file base_struct.h.

References IS_CHANGED.

Referenced by LIB_EDIT_FRAME::OnEditPin().

228 { return m_Flags & IS_CHANGED; }
#define IS_CHANGED
std::function passed to nested users by ref, avoids copying std::function
Definition: base_struct.h:105
STATUS_FLAGS m_Flags
Flag bits for editing and other uses.
Definition: base_struct.h:186
bool EDA_ITEM::IsNew ( ) const
inlineinherited

Definition at line 227 of file base_struct.h.

References IS_NEW.

Referenced by Abort_Edit_Pcb_Text(), Abort_EditEdge(), Abort_Move_ModuleOutline(), Abort_MoveOrCopyModule(), Abort_Zone_Create_Outline(), AbortBuildDimension(), AbortMoveAndEditTarget(), abortMoveBitmap(), abortMoveItem(), AbortPinMove(), AbortSymbolTraceOn(), SCH_EDIT_FRAME::addCurrentItemToList(), SCH_EDIT_FRAME::addJunctionMenuEntries(), AddMenusForBus(), AddMenusForWire(), PCB_EDIT_FRAME::Delete_Segment(), PCB_EDIT_FRAME::Delete_Segment_Edge(), SCH_EDIT_FRAME::DeleteCurrentSegment(), LIB_ARC::drawEditGraphics(), LIB_ARC::drawGraphic(), DrawMovePin(), SCH_EDIT_FRAME::EditSheetPin(), LIB_PIN::EnableEditMode(), LIB_EDIT_FRAME::EndDrawGraphicItem(), SCH_EDIT_FRAME::EndSegment(), ExitSheet(), LIB_PART::LIB_PART(), SCH_EDIT_FRAME::OnAutoplaceFields(), SCH_EDIT_FRAME::OnConvertTextType(), LIB_EDIT_FRAME::OnEditPin(), SCH_EDIT_FRAME::OnHotKey(), FOOTPRINT_EDIT_FRAME::OnLeftClick(), LIB_EDIT_FRAME::OnLeftClick(), PCB_EDIT_FRAME::OnLeftClick(), FOOTPRINT_EDIT_FRAME::OnLeftDClick(), SCH_EDIT_FRAME::OnLeftDClick(), LIB_EDIT_FRAME::OnLeftDClick(), PCB_EDIT_FRAME::OnLeftDClick(), SCH_EDIT_FRAME::OnRightClick(), LIB_EDIT_FRAME::OnRightClick(), SCH_EDIT_FRAME::OnRotate(), PCB_EDIT_FRAME::Place_Texte_Pcb(), PCB_BASE_FRAME::PlaceModule(), LIB_EDIT_FRAME::PlacePin(), PCB_EDIT_FRAME::PlaceTarget(), SCH_EDIT_FRAME::PrepareMoveItem(), SCH_EDIT_FRAME::ReSizeSheet(), ShowClearance(), PCB_EDIT_FRAME::StartMoveTextePcb(), PCB_EDIT_FRAME::SwitchLayer(), and DIALOG_LABEL_EDITOR::TextPropertiesAccept().

227 { return m_Flags & IS_NEW; }
#define IS_NEW
New item, just created.
Definition: base_struct.h:109
STATUS_FLAGS m_Flags
Flag bits for editing and other uses.
Definition: base_struct.h:186
bool TRACK::IsNull ( )
inherited

Function IsNull returns true if segment length is zero.

Definition at line 249 of file class_track.cpp.

References TRACK::m_End, TRACK::m_Start, PCB_VIA_T, and EDA_ITEM::Type().

Referenced by ComputeBreakPoint(), DeleteNullTrackSegments(), and TRACK::GetLength().

250 {
251  if( ( Type() != PCB_VIA_T ) && ( m_Start == m_End ) )
252  return true;
253  else
254  return false;
255 }
KICAD_T Type() const
Function Type()
Definition: base_struct.h:209
wxPoint m_Start
Line start point.
Definition: class_track.h:342
wxPoint m_End
Line end point.
Definition: class_track.h:343
class VIA, a via (like a track segment on a copper layer)
Definition: typeinfo.h:96
bool VIA::IsOnLayer ( PCB_LAYER_ID  aLayer) const
overridevirtual

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
aLayerThe layer to test for.
Returns
bool - true if on given layer, else false.

Reimplemented from BOARD_ITEM.

Definition at line 376 of file class_track.cpp.

References LayerPair().

Referenced by TRACK::Draw(), SEGZONE::Draw(), Draw(), TRACK::DrawShortNetname(), and PlotLayerOutlines().

377 {
378  PCB_LAYER_ID bottom_layer, top_layer;
379 
380  LayerPair( &top_layer, &bottom_layer );
381 
382  wxASSERT( top_layer <= bottom_layer );
383 
384  if( top_layer <= layer_number && layer_number <= bottom_layer )
385  return true;
386  else
387  return false;
388 }
PCB_LAYER_ID
A quick note on layer IDs:
void LayerPair(PCB_LAYER_ID *top_layer, PCB_LAYER_ID *bottom_layer) const
Function LayerPair Return the 2 layers used by the via (the via actually uses all layers between thes...
STATUS_FLAGS TRACK::IsPointOnEnds ( const wxPoint point,
int  min_dist = 0 
)
inherited

Function IsPointOnEnds returns STARTPOINT if point if near (dist = min_dist) start point, ENDPOINT if point if near (dist = min_dist) end point,STARTPOINT|ENDPOINT if point if near (dist = min_dist) both ends, or 0 if none of the above.

if min_dist < 0: min_dist = track_width/2

Definition at line 258 of file class_track.cpp.

References dist, ENDPOINT, GetLineLength(), KiROUND(), TRACK::m_End, TRACK::m_Start, TRACK::m_Width, and STARTPOINT.

Referenced by PCB_EDIT_FRAME::createPopupMenuForTracks(), TRACK::GetLength(), ROUTER_TOOL::NeighboringSegmentFilter(), and PCB_EDIT_FRAME::StartMoveOneNodeOrSegment().

259 {
260  STATUS_FLAGS result = 0;
261 
262  if( min_dist < 0 )
263  min_dist = m_Width / 2;
264 
265  if( min_dist == 0 )
266  {
267  if( m_Start == point )
268  result |= STARTPOINT;
269 
270  if( m_End == point )
271  result |= ENDPOINT;
272  }
273  else
274  {
275  double dist = GetLineLength( m_Start, point );
276 
277  if( min_dist >= KiROUND( dist ) )
278  result |= STARTPOINT;
279 
280  dist = GetLineLength( m_End, point );
281 
282  if( min_dist >= KiROUND( dist ) )
283  result |= ENDPOINT;
284  }
285 
286  return result;
287 }
wxPoint m_Start
Line start point.
Definition: class_track.h:342
double GetLineLength(const wxPoint &aPointA, const wxPoint &aPointB)
Function GetLineLength returns the length of a line segment defined by aPointA and aPointB...
Definition: trigo.h:191
static int KiROUND(double v)
Round a floating point number to an integer using "round halfway cases away from zero".
Definition: common.h:106
static const int dist[10][10]
Definition: dist.cpp:57
int m_Width
Thickness of track, or via diameter.
Definition: class_track.h:341
wxPoint m_End
Line end point.
Definition: class_track.h:343
unsigned STATUS_FLAGS
Definition: base_struct.h:142
#define ENDPOINT
Definition: base_struct.h:115
#define STARTPOINT
Definition: base_struct.h:114
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 455 of file base_struct.h.

References EDA_ITEM::operator<().

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

455 { return false; }
bool EDA_ITEM::IsResized ( ) const
inlineinherited

Definition at line 233 of file base_struct.h.

References IS_RESIZED.

Referenced by ExitSheet().

233 { return m_Flags & IS_RESIZED; }
STATUS_FLAGS m_Flags
Flag bits for editing and other uses.
Definition: base_struct.h:186
#define IS_RESIZED
Item being resized.
Definition: base_struct.h:110
bool EDA_ITEM::IsSelected ( ) const
inlineinherited

Definition at line 232 of file base_struct.h.

References SELECTED.

Referenced by SCH_SCREEN::addConnectedItemsToBlock(), AddMenusForPin(), KIGFX::PCB_PAINTER::draw(), LIB_CIRCLE::drawGraphic(), LIB_POLYLINE::drawGraphic(), LIB_RECTANGLE::drawGraphic(), LIB_BEZIER::drawGraphic(), LIB_TEXT::drawGraphic(), LIB_ARC::drawGraphic(), LIB_FIELD::drawGraphic(), DrawMovingBlockOutlines(), LIB_PIN::DrawPinElectricalTypeName(), LIB_PIN::DrawPinSymbol(), LIB_PIN::DrawPinTexts(), KIGFX::GERBVIEW_RENDER_SETTINGS::GetColor(), KIGFX::PCB_RENDER_SETTINGS::GetColor(), LIB_EDIT_FRAME::GlobalSetPins(), 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(), MirrorMarkedItems(), MoveMarkedItems(), MoveMarkedItemsExactly(), LIB_TEXT::Plot(), RotateMarkedItems(), SELECTION_TOOL::SanitizeSelection(), GERBVIEW_SELECTION_TOOL::select(), SELECTION_TOOL::select(), SCH_SCREEN::SelectBlockItems(), GERBVIEW_SELECTION_TOOL::toggleSelection(), SELECTION_TOOL::toggleSelection(), GERBVIEW_SELECTION_TOOL::unselect(), and SELECTION_TOOL::unselect().

232 { return m_Flags & SELECTED; }
#define SELECTED
Definition: base_struct.h:116
STATUS_FLAGS m_Flags
Flag bits for editing and other uses.
Definition: base_struct.h:186
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 185 of file class_board_item.h.

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

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

186  {
187  return ( Type() == PCB_TRACE_T ) || ( Type() == PCB_VIA_T );
188  }
KICAD_T Type() const
Function Type()
Definition: base_struct.h:209
class TRACK, a track segment (segment on a copper layer)
Definition: typeinfo.h:95
class VIA, a via (like a track segment on a copper layer)
Definition: typeinfo.h:96
bool EDA_ITEM::IsWireImage ( ) const
inlineinherited

Definition at line 231 of file base_struct.h.

References IS_WIRE_IMAGE.

Referenced by abortMoveItem(), and SCH_FIELD::Draw().

231 { return m_Flags & IS_WIRE_IMAGE; }
#define IS_WIRE_IMAGE
Item to be drawn as wireframe while editing.
Definition: base_struct.h:113
STATUS_FLAGS m_Flags
Flag bits for editing and other uses.
Definition: base_struct.h:186
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
listStartThe first in a list of EDA_ITEMs to iterate over.
inspectorIs an INSPECTOR to call on each object that is one of the requested scanTypes.
testDataIs 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.
scanTypesA 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 131 of file base_struct.cpp.

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(), EDA_ITEM::HitTest(), GERBER_FILE_IMAGE::Visit(), MODULE::Visit(), and BOARD::Visit().

135 {
136  EDA_ITEM* p = listStart;
137 
138  for( ; p; p = p->Pnext )
139  {
140  if( SEARCH_QUIT == p->Visit( inspector, testData, scanTypes ) )
141  return SEARCH_QUIT;
142  }
143 
144  return SEARCH_CONTINUE;
145 }
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...
Class EDA_ITEM is a base class for most all the KiCad significant classes, used in schematics and boa...
Definition: base_struct.h:162
EDA_ITEM * Pnext
next in linked list
Definition: base_struct.h:175
void VIA::LayerPair ( PCB_LAYER_ID top_layer,
PCB_LAYER_ID bottom_layer 
) const

Function LayerPair Return the 2 layers used by the via (the via actually uses all layers between these 2 layers)

Parameters
top_layer= pointer to the first layer (can be null)
bottom_layer= pointer to the last layer (can be null)

Definition at line 433 of file class_track.cpp.

References B_Cu, F_Cu, GetViaType(), m_BottomLayer, BOARD_ITEM::m_Layer, and VIA_THROUGH.

Referenced by build_via_testpoints(), DRC::doTrackDrc(), KIGFX::PCB_PAINTER::draw(), Draw(), export_vrml_via(), Flip(), PCB_IO::format(), C3D_RENDER_OGL_LEGACY::generate_3D_Vias_and_Pads(), GetMsgPanelInfoBase(), GetSelectMenuText(), GENDRILL_WRITER_BASE::getUniqueLayerPairs(), C3D_RENDER_RAYTRACING::insert3DViaHole(), IsOnLayer(), PCB_EDIT_FRAME::Swap_Layers(), and PNS_KICAD_IFACE::syncVia().

434 {
435  PCB_LAYER_ID t_layer = F_Cu;
436  PCB_LAYER_ID b_layer = B_Cu;
437 
438  if( GetViaType() != VIA_THROUGH )
439  {
440  b_layer = m_BottomLayer;
441  t_layer = m_Layer;
442 
443  if( b_layer < t_layer )
444  std::swap( b_layer, t_layer );
445  }
446 
447  if( top_layer )
448  *top_layer = t_layer;
449 
450  if( bottom_layer )
451  *bottom_layer = b_layer;
452 }
PCB_LAYER_ID m_Layer
PCB_LAYER_ID
A quick note on layer IDs:
VIATYPE_T GetViaType() const
Definition: class_track.h:460
PCB_LAYER_ID m_BottomLayer
The bottom layer of the via (the top layer is in m_Layer)
Definition: class_track.h:504
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
aSearchDataA reference to a wxFindReplaceData object containing the search criteria.
aAuxDataA pointer to optional data required for the search or NULL if not used.
aFindLocationA 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 411 of file base_struct.h.

References EDA_ITEM::Replace().

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

412  {
413  return false;
414  }
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
aTextA reference to a wxString object containing the string to test.
aSearchDataThe criteria to search against.
Returns
True if aText matches the search criteria in aSearchData.

Definition at line 183 of file base_struct.cpp.

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

184 {
185  wxString text = aText;
186  wxString searchText = aSearchData.GetFindString();
187 
188  // Don't match if searching for replaceable item and the item doesn't support text replace.
189  if( (aSearchData.GetFlags() & FR_SEARCH_REPLACE) && !IsReplaceable() )
190  return false;
191 
192  if( aSearchData.GetFlags() & wxFR_WHOLEWORD )
193  return aText.IsSameAs( searchText, aSearchData.GetFlags() & wxFR_MATCHCASE );
194 
195  if( aSearchData.GetFlags() & FR_MATCH_WILDCARD )
196  {
197  if( aSearchData.GetFlags() & wxFR_MATCHCASE )
198  return text.Matches( searchText );
199 
200  return text.MakeUpper().Matches( searchText.MakeUpper() );
201  }
202 
203  if( aSearchData.GetFlags() & wxFR_MATCHCASE )
204  return aText.Find( searchText ) != wxNOT_FOUND;
205 
206  return text.MakeUpper().Find( searchText.MakeUpper() ) != wxNOT_FOUND;
207 }
virtual bool IsReplaceable() const
Function IsReplaceable.
Definition: base_struct.h:455
Perform search using simple wild card matching (* & ?).
Perform a search for a item that has replaceable text.
virtual void TRACK::Move ( const wxPoint aMoveVector)
inlineoverridevirtualinherited

Function Move move this object.

Parameters
aMoveVector- the move vector for this object.

Reimplemented from BOARD_ITEM.

Definition at line 102 of file class_track.h.

References TRACK::Flip(), TRACK::m_End, TRACK::m_Start, and TRACK::Rotate().

103  {
104  m_Start += aMoveVector;
105  m_End += aMoveVector;
106  }
wxPoint m_Start
Line start point.
Definition: class_track.h:342
wxPoint m_End
Line end point.
Definition: class_track.h:343
void BOARD_ITEM::Move ( const VECTOR2I aMoveVector)
inlineinherited

Definition at line 240 of file class_board_item.h.

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

241  {
242  Move( wxPoint( aMoveVector.x, aMoveVector.y ) );
243  }
virtual void Move(const wxPoint &aMoveVector)
Function Move move this object.
TRACK* TRACK::Next ( ) const
inlineinherited

Definition at line 99 of file class_track.h.

References EDA_ITEM::Pnext.

Referenced by DIALOG_GLOBAL_DELETION::AcceptPcbDelete(), C3D_RENDER_RAYTRACING::add_3D_vias_and_pads_to_container(), PCB_EDIT_FRAME::Attribut_net(), PCB_EDIT_FRAME::Attribut_Track(), build_via_testpoints(), BOARD::chainMarkedSegments(), PCB_EDIT_FRAME::Change_Net_Tracks_And_Vias_Sizes(), TRACKS_CLEANER::cleanupSegments(), Collect_TrackSegmentsToDrag(), BOARD::ComputeBoundingBox(), BOARD::ConvertBrdLayerToPolygonalContours(), CINFO3D_VISU::createLayers(), BOARD::CreateLockPoint(), CreateRoutesSection(), CreateTracksInfoData(), PCB_EDIT_FRAME::Delete_net(), TRACKS_CLEANER::deleteDanglingTracks(), DeleteNullTrackSegments(), PYTHON_ACTION_PLUGINS::deregister_action(), PCB_DRAW_PANEL_GAL::DisplayBoard(), DRC::doTrackDrc(), BOARD::Draw(), BOARD::DrawHighLight(), DrawTraces(), PCB_EDIT_FRAME::Edit_Track_Width(), PCB_EDIT_FRAME::EraseRedundantTrack(), export_vrml_tracks(), PCB_IO::format(), C3D_RENDER_OGL_LEGACY::generate_3D_Vias_and_Pads(), TRACK::GetBestInsertPoint(), TRACK::GetEndSegments(), GetFirstTrack(), GetFirstVia(), PCB_DRAW_PANEL_GAL::GetMsgPanelInfo(), NETINFO_ITEM::GetMsgPanelInfo(), BOARD::GetMsgPanelInfo(), GetTrack(), TRACK::GetTrack(), BOARD::GetVisibleTrack(), DIALOG_GENDRILL::InitDisplayParams(), LocateIntrusion(), Magnetize(), BOARD::MarkTrace(), TRACKS_CLEANER::MergeCollinearTracks(), DIALOG_GLOBAL_EDIT_TRACKS_AND_VIAS::OnOkClick(), PlaceCells(), BRDITEMS_PLOTTER::PlotDrillMarks(), PlotLayerOutlines(), PlotSolderMaskLayer(), PlotStandardLayer(), PCB_EDIT_FRAME::PrintPage(), PCB_EDIT_FRAME::Remove_One_Track(), TRACKS_CLEANER::removeDuplicatesOfVia(), PCB_EDIT_FRAME::Reset_All_Tracks_And_Vias_To_Netclass_Values(), SELECTION_TOOL::selectAllItemsConnectedToTrack(), DRC::testKeepoutAreas(), DRC::testTexts(), DRC::testTracks(), and NETINFO_MAPPING::Update().

99 { return static_cast<TRACK*>( Pnext ); }
EDA_ITEM * Pnext
next in linked list
Definition: base_struct.h:175
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 240 of file base_struct.cpp.

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

Referenced by EDA_ITEM::IsReplaceable(), and LIB_ALIAS::operator==().

241 {
242  wxFAIL_MSG( wxString::Format( wxT( "Less than operator not defined for item type %s." ),
243  GetChars( GetClass() ) ) );
244 
245  return false;
246 }
static const wxChar * GetChars(const wxString &s)
Function GetChars returns a wxChar* to the actual wxChar* data within a wxString, and is helpful for ...
Definition: macros.h:92
virtual wxString GetClass() const =0
Function GetClass returns the class name.
void Format(OUTPUTFORMATTER *out, int aNestLevel, int aCtl, CPTREE &aTree)
Function Format outputs a PTREE into s-expression format via an OUTPUTFORMATTER derivative.
Definition: ptree.cpp:205
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
aSearchDataA reference to a wxFindReplaceData object containing the search and replace criteria.
aTextA reference to a wxString object containing the text to be replaced.
Returns
True if aText was modified, otherwise false.

Definition at line 210 of file base_struct.cpp.

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

Referenced by EDA_ITEM::Matches(), SCH_TEXT::Replace(), SCH_FIELD::Replace(), SCH_SHEET_PIN::Replace(), SCH_SHEET::Replace(), and SCH_FIND_COLLECTOR::ReplaceItem().

211 {
212  wxCHECK_MSG( IsReplaceable(), false,
213  wxT( "Attempt to replace text in <" ) + GetClass() + wxT( "> item." ) );
214 
215  wxString searchString = (aSearchData.GetFlags() & wxFR_MATCHCASE) ? aText : aText.Upper();
216 
217  int result = searchString.Find( (aSearchData.GetFlags() & wxFR_MATCHCASE) ?
218  aSearchData.GetFindString() :
219  aSearchData.GetFindString().Upper() );
220 
221  if( result == wxNOT_FOUND )
222  return false;
223 
224  wxString prefix = aText.Left( result );
225  wxString suffix;
226 
227  if( aSearchData.GetFindString().length() + result < aText.length() )
228  suffix = aText.Right( aText.length() - ( aSearchData.GetFindString().length() + result ) );
229 
230  wxLogTrace( traceFindReplace, wxT( "Replacing '%s', prefix '%s', replace '%s', suffix '%s'." ),
231  GetChars( aText ), GetChars( prefix ), GetChars( aSearchData.GetReplaceString() ),
232  GetChars( suffix ) );
233 
234  aText = prefix + aSearchData.GetReplaceString() + suffix;
235 
236  return true;
237 }
virtual bool IsReplaceable() const
Function IsReplaceable.
Definition: base_struct.h:455
const wxChar *const traceFindReplace
Flag to enable find and replace debug tracing.
static const wxChar * GetChars(const wxString &s)
Function GetChars returns a wxChar* to the actual wxChar* data within a wxString, and is helpful for ...
Definition: macros.h:92
virtual wxString GetClass() const =0
Function GetClass returns the class name.
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
aSearchDataA reference to a wxFindReplaceData object containing the search and replace criteria.
aAuxDataA 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 443 of file base_struct.h.

443 { return false; }
void TRACK::Rotate ( const wxPoint aRotCentre,
double  aAngle 
)
overridevirtualinherited

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 326 of file class_track.cpp.

References TRACK::m_End, TRACK::m_Start, and RotatePoint().

Referenced by TRACK::Move().

327 {
328  RotatePoint( &m_Start, aRotCentre, aAngle );
329  RotatePoint( &m_End, aRotCentre, aAngle );
330 }
wxPoint m_Start
Line start point.
Definition: class_track.h:342
void RotatePoint(int *pX, int *pY, double angle)
Definition: trigo.cpp:216
wxPoint m_End
Line end point.
Definition: class_track.h:343
void BOARD_ITEM::Rotate ( const VECTOR2I aRotCentre,
double  aAngle 
)
inlineinherited

Definition at line 256 of file class_board_item.h.

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

257  {
258  Rotate( wxPoint( aRotCentre.x, aRotCentre.y ), aAngle );
259  }
virtual void Rotate(const wxPoint &aRotCentre, double aAngle)
Function Rotate Rotate this object.
void VIA::SanitizeLayers ( )

Function SanitizeLayers Check so that the layers are correct dependin on the type of via, and so that the top actually is on top.

Definition at line 467 of file class_track.cpp.

References B_Cu, F_Cu, GetViaType(), m_BottomLayer, BOARD_ITEM::m_Layer, and VIA_THROUGH.

Referenced by DIALOG_TRACK_VIA_PROPERTIES::Apply(), and SetLayerPair().

468 {
469  if( GetViaType() == VIA_THROUGH )
470  {
471  m_Layer = F_Cu;
473  }
474 
475  if( m_BottomLayer < m_Layer )
476  std::swap( m_BottomLayer, m_Layer );
477 }
PCB_LAYER_ID m_Layer
VIATYPE_T GetViaType() const
Definition: class_track.h:460
PCB_LAYER_ID m_BottomLayer
The bottom layer of the via (the top layer is in m_Layer)
Definition: class_track.h:504
void VIA::SetBottomLayer ( PCB_LAYER_ID  aLayer)

Definition at line 427 of file class_track.cpp.

References m_BottomLayer.

Referenced by DIALOG_TRACK_VIA_PROPERTIES::Apply().

428 {
429  m_BottomLayer = aLayer;
430 }
PCB_LAYER_ID m_BottomLayer
The bottom layer of the via (the top layer is in m_Layer)
Definition: class_track.h:504
void EDA_ITEM::SetBrightened ( )
inlineinherited

Definition at line 240 of file base_struct.h.

References BRIGHTENED, and EDA_ITEM::SetFlags().

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

240 { SetFlags( BRIGHTENED ); }
void SetFlags(STATUS_FLAGS aMask)
Definition: base_struct.h:264
#define BRIGHTENED
item is drawn with a bright contour
Definition: base_struct.h:133
void VIA::SetDrill ( int  aDrill)
inline

Function SetDrill sets the drill value for vias.

Parameters
aDrillis the new drill diameter

Definition at line 468 of file class_track.h.

Referenced by PNS_KICAD_IFACE::AddItem(), PCAD2KICAD::PCB_PAD::AddToBoard(), DIALOG_TRACK_VIA_PROPERTIES::Apply(), DRAWING_TOOL::DrawVia(), EAGLE_PLUGIN::loadSignals(), LEGACY_PLUGIN::loadTrackList(), PCB_EDIT_FRAME::Other_Layer_Route(), and PCB_EDIT_FRAME::SetTrackSegmentWidth().

468 { m_Drill = aDrill; }
int m_Drill
Definition: class_track.h:508
void VIA::SetDrillDefault ( )
inline

Function SetDrillDefault sets the drill value for vias to the default value UNDEFINED_DRILL_DIAMETER.

Definition at line 489 of file class_track.h.

References UNDEFINED_DRILL_DIAMETER.

Referenced by LEGACY_PLUGIN::loadTrackList(), PCB_EDIT_FRAME::SetTrackSegmentWidth(), and VIA().

int m_Drill
Definition: class_track.h:508
#define UNDEFINED_DRILL_DIAMETER
Definition: class_track.h:59
void EDA_ITEM::SetFlags ( STATUS_FLAGS  aMask)
inlineinherited

Definition at line 264 of file base_struct.h.

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(), PCB_EDIT_FRAME::Change_Side_Module(), SCH_EDIT_FRAME::ConvertPart(), SCH_EDIT_FRAME::copyBlockItems(), CopyMarkedItems(), DIALOG_EDIT_COMPONENT_IN_SCHEMATIC::copyPanelToOptions(), LIB_PART::CopySelectedItems(), 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(), PCB_EDIT_FRAME::EditDimension(), PCB_EDIT_FRAME::FlipTextePcb(), LIB_EDIT_FRAME::GetComponentFromRedoList(), LIB_EDIT_FRAME::GetComponentFromUndoList(), SCH_SCREEN::GetConnection(), PCB_BASE_FRAME::GlobalChange_PadSettings(), FOOTPRINT_EDIT_FRAME::HandleBlockEnd(), PCB_BASE_FRAME::Import_Pad_Settings(), SCH_EDIT_FRAME::ImportSheetPin(), 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(), moveBitmap(), SCH_EDIT_FRAME::MoveImage(), SCH_EDIT_FRAME::OnConvertTextType(), SCH_EDIT_FRAME::OnCopySchematicItemRequest(), LIB_EDIT_FRAME::OnEditPin(), TARGET_PROPERTIES_DIALOG_EDITOR::OnOkClick(), SCH_EDIT_FRAME::OnSelectUnit(), KIGFX::ORIGIN_VIEWITEM::ORIGIN_VIEWITEM(), PCB_EDIT_FRAME::Other_Layer_Route(), DRAWING_TOOL::PlaceText(), SCH_EDIT_FRAME::PrepareMoveItem(), LIB_EDIT_FRAME::Process_Special_Functions(), EDIT_TOOL::Properties(), 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_PCB_TEXT_PROPERTIES::TransferDataFromWindow(), DIALOG_PAD_PROPERTIES::TransferDataFromWindow(), and UndrawAndMarkSegmentsToDrag().

264 { m_Flags |= aMask; }
STATUS_FLAGS m_Flags
Flag bits for editing and other uses.
Definition: base_struct.h:186
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
aEnableTrue 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 276 of file base_struct.h.

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

276 { m_forceVisible = aEnable; }
bool m_forceVisible
Set to true to override the visibility setting of the item.
Definition: base_struct.h:183
void EDA_ITEM::SetHighlighted ( )
inlineinherited

Definition at line 239 of file base_struct.h.

References HIGHLIGHTED, and EDA_ITEM::SetFlags().

239 { SetFlags( HIGHLIGHTED ); }
void SetFlags(STATUS_FLAGS aMask)
Definition: base_struct.h:264
#define HIGHLIGHTED
item is drawn in normal colors, when the rest is darkened
Definition: base_struct.h:132
virtual void BOARD_ITEM::SetLayer ( PCB_LAYER_ID  aLayer)
inlinevirtualinherited

Function SetLayer sets the layer this item is on.

Parameters
aLayerThe 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 141 of file class_board_item.h.

References BOARD_ITEM::Draw(), and BOARD_ITEM::SwapData().

Referenced by DXF2BRD_CONVERTER::addArc(), DXF2BRD_CONVERTER::addCircle(), PNS_KICAD_IFACE::AddItem(), DXF2BRD_CONVERTER::addLine(), DXF2BRD_CONVERTER::addMText(), DXF2BRD_CONVERTER::addText(), PCAD2KICAD::PCB_TEXT::AddToBoard(), PCAD2KICAD::PCB_LINE::AddToBoard(), PCAD2KICAD::PCB_ARC::AddToBoard(), PCAD2KICAD::PCB_PAD::AddToBoard(), PCAD2KICAD::PCB_MODULE::AddToBoard(), PCAD2KICAD::PCB_LINE::AddToModule(), PCAD2KICAD::PCB_ARC::AddToModule(), PCAD2KICAD::PCB_POLYGON::AddToModule(), DIMENSION::AdjustDimensionDetails(), DIALOG_TRACK_VIA_PROPERTIES::Apply(), PCB_EDIT_FRAME::Begin_DrawSegment(), FOOTPRINT_EDIT_FRAME::Begin_Edge_Module(), PCB_EDIT_FRAME::Begin_Route(), PCB_EDIT_FRAME::Create_MuWavePolygonShape(), MWAVE::CreateMicrowaveInductor(), PCB_BASE_FRAME::CreateNewModule(), PCB_EDIT_FRAME::CreateTarget(), PCB_EDIT_FRAME::CreateTextePcb(), FOOTPRINT_EDIT_FRAME::CreateTextModule(), DRAWING_TOOL::drawArc(), DRAWING_TOOL::drawSegment(), FOOTPRINT_EDIT_FRAME::Edit_Edge_Layer(), PCB_TARGET::Flip(), TEXTE_PCB::Flip(), EDGE_MODULE::Flip(), TEXTE_MODULE::Flip(), TRACK::Flip(), DRAWSEGMENT::Flip(), MODULE::Flip(), genPlacementRoutingMatrix(), DXF2BRD_CONVERTER::insertArc(), DXF2BRD_CONVERTER::insertLine(), LEGACY_PLUGIN::loadMODULE(), LEGACY_PLUGIN::loadMODULE_TEXT(), LEGACY_PLUGIN::loadPCB_TEXT(), EAGLE_PLUGIN::loadPlain(), EAGLE_PLUGIN::loadSignals(), LEGACY_PLUGIN::loadTrackList(), DSN::SPECCTRA_DB::makeTRACK(), PCB_EDIT_FRAME::Other_Layer_Route(), EAGLE_PLUGIN::packageCircle(), EAGLE_PLUGIN::packagePolygon(), EAGLE_PLUGIN::packageRectangle(), EAGLE_PLUGIN::packageSMD(), EAGLE_PLUGIN::packageText(), EAGLE_PLUGIN::packageWire(), GPCB_FPL_CACHE::parseMODULE(), PlaceCells(), DRAWING_TOOL::PlaceDXF(), DRAWING_TOOL::PlaceText(), BRDITEMS_PLOTTER::PlotDimension(), BRDITEMS_PLOTTER::PlotPcbTarget(), DIALOG_PAD_PROPERTIES::redraw(), DIMENSION::SetLayer(), ShowNewTrackWhenMovingCursor(), PCB_EDIT_FRAME::Swap_Layers(), TEXTE_MODULE::TEXTE_MODULE(), DIALOG_EDIT_FPTEXT::TransferDataFromWindow(), DIALOG_PCB_TEXT_PROPERTIES::TransferDataFromWindow(), DIALOG_MODEDIT_FP_BODY_ITEM_PROPERTIES::TransferDataFromWindow(), and DIALOG_GRAPHIC_ITEM_PROPERTIES::TransferDataFromWindow().

142  {
143  // trap any invalid layers, then go find the caller and fix it.
144  // wxASSERT( unsigned( aLayer ) < unsigned( NB_PCB_LAYERS ) );
145  m_Layer = aLayer;
146  }
PCB_LAYER_ID m_Layer
void VIA::SetLayerPair ( PCB_LAYER_ID  aTopLayer,
PCB_LAYER_ID  aBottomLayer 
)

Function SetLayerPair For a via m_Layer contains the top layer, the other layer is in m_BottomLayer.

Parameters
aTopLayer= first layer connected by the via
aBottomLayer= last layer connected by the via

Definition at line 412 of file class_track.cpp.

References m_BottomLayer, BOARD_ITEM::m_Layer, and SanitizeLayers().

Referenced by PNS_KICAD_IFACE::AddItem(), PCAD2KICAD::PCB_PAD::AddToBoard(), DRAWING_TOOL::DrawVia(), Flip(), EAGLE_PLUGIN::loadSignals(), LEGACY_PLUGIN::loadTrackList(), PCB_EDIT_FRAME::Other_Layer_Route(), and PCB_EDIT_FRAME::Swap_Layers().

413 {
414 
415  m_Layer = aTopLayer;
416  m_BottomLayer = aBottomLayer;
417  SanitizeLayers();
418 }
PCB_LAYER_ID m_Layer
PCB_LAYER_ID m_BottomLayer
The bottom layer of the via (the top layer is in m_Layer)
Definition: class_track.h:504
void SanitizeLayers()
Function SanitizeLayers Check so that the layers are correct dependin on the type of via...
void EDA_ITEM::SetList ( DHEAD aList)
inlineinherited

Definition at line 225 of file base_struct.h.

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

225 { m_List = aList; }
DHEAD * m_List
which DLIST I am on.
Definition: base_struct.h:177
void BOARD_CONNECTED_ITEM::SetLocalRatsnestVisible ( bool  aVisible)
inlineinherited

Definition at line 163 of file board_connected_item.h.

References BOARD_CONNECTED_ITEM::m_localRatsnestVisible.

164  {
165  m_localRatsnestVisible = aVisible;
166  }
void TRACK::SetLocked ( bool  aLocked)
inlineoverridevirtualinherited

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

Reimplemented from BOARD_ITEM.

Definition at line 142 of file class_track.h.

References TRACK::GetBestInsertPoint(), TRACK::GetEndNetCode(), TRACK::GetStartNetCode(), EDA_ITEM::SetState(), and TRACK_LOCKED.

Referenced by DIALOG_TRACK_VIA_PROPERTIES::Apply().

143  {
144  return SetState( TRACK_LOCKED, aLocked );
145  }
#define TRACK_LOCKED
Pcbnew: track locked: protected from global deletion.
Definition: base_struct.h:124
void SetState(int type, int state)
Definition: base_struct.h:253
void EDA_ITEM::SetModified ( )
inherited
void BOARD_CONNECTED_ITEM::SetNet ( NETINFO_ITEM aNetInfo)
inlineinherited

Function SetNet Sets a NET_INFO object for the item.

Definition at line 93 of file board_connected_item.h.

References BOARD_ITEM::GetBoard(), and BOARD_CONNECTED_ITEM::m_netinfo.

94  {
95  assert( aNetInfo->GetBoard() == GetBoard() );
96  m_netinfo = aNetInfo;
97  }
NETINFO_ITEM * m_netinfo
Stores all informations about the net that item belongs to.
virtual BOARD * GetBoard() const
Function GetBoard returns the BOARD in which this BOARD_ITEM resides, or NULL if none.
bool BOARD_CONNECTED_ITEM::SetNetCode ( int  aNetCode,
bool  aNoAssert = false 
)
inherited

Function SetNetCode sets net using a net code.

Parameters
aNetCodeis a net code for the new net. It has to exist in NETINFO_LIST held by BOARD.
aNoAssertif true, do not assert that the net exists. Otherwise, item is assigned to the unconnected net.
Returns
true on success, false if the net did not exist

Definition at line 46 of file board_connected_item.cpp.

References BOARD::FindNet(), BOARD_ITEM::GetBoard(), BOARD_CONNECTED_ITEM::m_netinfo, and NETINFO_LIST::ORPHANED_ITEM.

Referenced by PNS_KICAD_IFACE::AddItem(), PCAD2KICAD::PCB_LINE::AddToBoard(), PCAD2KICAD::PCB_PAD::AddToBoard(), PCAD2KICAD::PCB_POLYGON::AddToBoard(), PCAD2KICAD::PCB_PAD::AddToModule(), DIALOG_TRACK_VIA_PROPERTIES::Apply(), PCB_EDIT_FRAME::Begin_Zone(), D_PAD::CopyNetlistSettings(), BOARD_NETLIST_UPDATER::deleteSinglePadNets(), DRAWING_TOOL::DrawVia(), PCB_EDIT_FRAME::Edit_Zone_Params(), ZONE_SETTINGS::ExportSetting(), genPlacementRoutingMatrix(), BOARD_CONNECTED_ITEM::GetNetCode(), BOARD::InsertArea(), EAGLE_PLUGIN::loadPlain(), EAGLE_PLUGIN::loadSignals(), LEGACY_PLUGIN::loadTrackList(), DSN::SPECCTRA_DB::makeTRACK(), PCB_EDIT_FRAME::Other_Layer_Route(), BOARD::ReplaceNetlist(), CLIPBOARD_IO::SaveSelection(), BOARD::SetAreasNetCodesFromNetNames(), DIALOG_PAD_PROPERTIES::TransferDataFromWindow(), DIALOG_PAD_PROPERTIES::transferDataToPad(), and ZONE_CONTAINER::ZONE_CONTAINER().

47 {
48  // if aNetCode < 0 ( typically NETINFO_LIST::FORCE_ORPHANED )
49  // or no parent board,
50  // set the m_netinfo to the dummy NETINFO_LIST::ORPHANED
51 
52  BOARD* board = GetBoard();
53  //auto connectivity = board ? board->GetConnectivity() : nullptr;
54  //bool addRatsnest = false;
55 
56  //if( connectivity )
57  //addRatsnest = connectivity->Remove( this );
58 
59  if( ( aNetCode >= 0 ) && board )
60  m_netinfo = board->FindNet( aNetCode );
61  else
63 
64  if( !aNoAssert )
65  assert( m_netinfo );
66 
67  // Add only if it was previously added to the ratsnest
68  //if( addRatsnest )
69  // connectivity->Add( this );
70 
71  return ( m_netinfo != NULL );
72 }
static NETINFO_ITEM ORPHANED_ITEM
NETINFO_ITEM meaning that there was no net assigned for an item, as there was no board storing net li...
Definition: netinfo.h:469
Class BOARD holds information pertinent to a Pcbnew printed circuit board.
Definition: class_board.h:169
NETINFO_ITEM * m_netinfo
Stores all informations about the net that item belongs to.
NETINFO_ITEM * FindNet(int aNetcode) const
Function FindNet searches for a net with the given netcode.
virtual BOARD * GetBoard() const
Function GetBoard returns the BOARD in which this BOARD_ITEM resides, or NULL if none.
void EDA_ITEM::SetParent ( EDA_ITEM aParent)
inlineinherited

Definition at line 224 of file base_struct.h.

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(), DISPLAY_FOOTPRINTS_FRAME::Get_Module(), DIALOG_FOOTPRINT_FP_EDITOR::initModeditProperties(), DIALOG_FOOTPRINT_BOARD_EDITOR::InitModeditProperties(), LIB_PART::LIB_PART(), FOOTPRINT_EDIT_FRAME::Load_Module_From_BOARD(), SCH_LEGACY_PLUGIN::loadHierarchy(), LIB_EDIT_FRAME::LoadOneSymbol(), MODULE::MODULE(), DIALOG_FOOTPRINT_BOARD_EDITOR::OnEditReference(), DIALOG_FOOTPRINT_BOARD_EDITOR::OnEditValue(), DIALOG_LIB_EDIT_PIN::OnPaintShowPanel(), MODULE::operator=(), SCH_COMPONENT::operator=(), PCB_PARSER::parseMODULE_unchecked(), LIB_EDIT_FRAME::pasteClipboard(), PCBNEW_CONTROL::PasteItemsFromClipboard(), FOOTPRINT_EDIT_FRAME::Process_Special_Functions(), BOARD_COMMIT::Push(), FOOTPRINT_PREVIEW_PANEL::renderFootprint(), BOARD_NETLIST_UPDATER::replaceComponent(), BOARD::ReplaceNetlist(), PCB_BASE_EDIT_FRAME::SaveCopyInUndoList(), SaveCopyOfZones(), 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(), and SwapItemData().

224 { m_Parent = aParent; }
EDA_ITEM * m_Parent
Linked list: Link (parent struct)
Definition: base_struct.h:179
void VIA::SetPosition ( const wxPoint aPoint)
inlineoverridevirtual

Reimplemented from TRACK.

Definition at line 433 of file class_track.h.

References TRACK::HitTest(), TRACK::m_End, and TRACK::m_Start.

Referenced by PNS_KICAD_IFACE::AddItem(), PCAD2KICAD::PCB_PAD::AddToBoard(), DIALOG_TRACK_VIA_PROPERTIES::Apply(), EAGLE_PLUGIN::loadSignals(), and PCB_EDIT_FRAME::Other_Layer_Route().

433 { m_Start = aPoint; m_End = aPoint; }
wxPoint m_Start
Line start point.
Definition: class_track.h:342
wxPoint m_End
Line end point.
Definition: class_track.h:343
void EDA_ITEM::SetSelected ( )
inlineinherited

Definition at line 238 of file base_struct.h.

References SELECTED, and EDA_ITEM::SetFlags().

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

238 { SetFlags( SELECTED ); }
#define SELECTED
Definition: base_struct.h:116
void SetFlags(STATUS_FLAGS aMask)
Definition: base_struct.h:264
void EDA_ITEM::SetStatus ( STATUS_FLAGS  aStatus)
inlineinherited
void EDA_ITEM::SetTimeStamp ( timestamp_t  aNewTimeStamp)
inlineinherited

Definition at line 214 of file base_struct.h.

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(), DuplicateItemsInList(), DuplicateStruct(), EDIT_TOOL::editFootprintInFpEditor(), PCB_EDIT_FRAME::Exchange_Module(), DIALOG_FOOTPRINT_BOARD_EDITOR::GotoModuleEditor(), 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(), FOOTPRINT_EDIT_FRAME::Process_Special_Functions(), PCB_EDIT_FRAME::Process_Special_Functions(), SCH_SCREENS::ReplaceDuplicateTimeStamps(), BOARD::ReplaceNetlist(), SCH_SHEET::SCH_SHEET(), SCH_COMPONENT::SetTimeStamp(), SimilarLabelsDiagnose(), SwapItemData(), TestDuplicateSheetNames(), and DIALOG_ERC::TestErc().

214 { m_TimeStamp = aNewTimeStamp; }
timestamp_t m_TimeStamp
Time stamp used for logical links.
Definition: base_struct.h:180
void VIA::SetTopLayer ( PCB_LAYER_ID  aLayer)

Definition at line 421 of file class_track.cpp.

References BOARD_ITEM::m_Layer.

Referenced by DIALOG_TRACK_VIA_PROPERTIES::Apply().

422 {
423  m_Layer = aLayer;
424 }
PCB_LAYER_ID m_Layer
void EDA_ITEM::SetWireImage ( )
inlineinherited

Definition at line 237 of file base_struct.h.

References IS_WIRE_IMAGE, and EDA_ITEM::SetFlags().

Referenced by moveItemWithMouseCursor().

237 { SetFlags( IS_WIRE_IMAGE ); }
void SetFlags(STATUS_FLAGS aMask)
Definition: base_struct.h:264
#define IS_WIRE_IMAGE
Item to be drawn as wireframe while editing.
Definition: base_struct.h:113
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.

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(), DRAWSEGMENT::Rotate(), and BOARD_ITEM::SetLocked().

40 {
41  switch( aShape )
42  {
43  case S_SEGMENT: return _( "Line" );
44  case S_RECT: return _( "Rect" );
45  case S_ARC: return _( "Arc" );
46  case S_CIRCLE: return _( "Circle" );
47  case S_CURVE: return _( "Bezier Curve" );
48  case S_POLYGON: return _( "Polygon" );
49  default: return wxT( "??" );
50  }
51 }
polygon (not yet used for tracks, but could be in microwave apps)
usual segment : line with rounded ends
segment with non rounded ends
Arcs (with rounded ends)
Bezier Curve.
wxString TRACK::ShowWidth ( ) const
inherited

Function ShowWidth returns the width of the track in displayable user units.

Definition at line 111 of file class_track.cpp.

References CoordinateToString(), and TRACK::m_Width.

Referenced by TRACK::GetLength(), TRACK::GetSelectMenuText(), and GetSelectMenuText().

112 {
113  wxString msg = ::CoordinateToString( m_Width );
114  return msg;
115 }
wxString CoordinateToString(int aValue, bool aConvertToMils)
Function CoordinateToString is a helper to convert the integer coordinate aValue to a string in inche...
Definition: base_units.cpp:118
int m_Width
Thickness of track, or via diameter.
Definition: class_track.h:341
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
aLeftThe left hand item to compare.
aRightThe right hand item to compare.
Returns
True if aLeft is less than aRight.

Definition at line 474 of file base_struct.h.

References EDA_ITEM::Matches(), EDA_ITEM::operator=(), EDA_ITEM::ViewBBox(), and EDA_ITEM::ViewGetLayers().

Referenced by PART_LIB::GetEntryTypePowerNames().

474 { return *aLeft < *aRight; }
void VIA::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 edition 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 TRACK.

Definition at line 1664 of file class_track.cpp.

References BEGIN_ONPAD, BUSY, DO_NOT_DRAW, END_ONPAD, FLAG0, FLAG1, IN_EDIT, IS_DELETED, IS_DRAGGED, IS_LINKED, PCB_VIA_T, TRACK_AR, TRACK_LOCKED, and EDA_ITEM::Type().

1665 {
1666  assert( aImage->Type() == PCB_VIA_T );
1667 
1668  std::swap( *((VIA*) this), *((VIA*) aImage) );
1669 }
KICAD_T Type() const
Function Type()
Definition: base_struct.h:209
class VIA, a via (like a track segment on a copper layer)
Definition: typeinfo.h:96
PCB_LAYER_ID VIA::TopLayer ( ) const

Definition at line 455 of file class_track.cpp.

References BOARD_ITEM::m_Layer.

Referenced by DIALOG_TRACK_VIA_PROPERTIES::DIALOG_TRACK_VIA_PROPERTIES().

456 {
457  return m_Layer;
458 }
PCB_LAYER_ID m_Layer
void TRACK::TransformShapeWithClearanceToPolygon ( SHAPE_POLY_SET aCornerBuffer,
int  aClearanceValue,
int  aCircleToSegmentsCount,
double  aCorrectionFactor 
) const
overridevirtualinherited

Function TransformShapeWithClearanceToPolygon Convert the track shape to a closed polygon Used in filling zones calculations Circles (vias) and arcs (ends of tracks) 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)

Reimplemented from BOARD_ITEM.

Definition at line 626 of file board_items_to_polygon_shape_transform.cpp.

References KiROUND(), PCB_VIA_T, TransformCircleToPolygon(), and TransformOvalClearanceToPolygon().

Referenced by CINFO3D_VISU::createLayers(), TRACK::GetLength(), and PlotSolderMaskLayer().

630 {
631  switch( Type() )
632  {
633  case PCB_VIA_T:
634  {
635  int radius = (m_Width / 2) + aClearanceValue;
636  radius = KiROUND( radius * aCorrectionFactor );
637  TransformCircleToPolygon( aCornerBuffer, m_Start, radius, aCircleToSegmentsCount );
638  }
639  break;
640 
641  default:
643  m_Width + ( 2 * aClearanceValue),
644  aCircleToSegmentsCount,
645  aCorrectionFactor );
646  break;
647  }
648 }
KICAD_T Type() const
Function Type()
Definition: base_struct.h:209
wxPoint m_Start
Line start point.
Definition: class_track.h:342
static int KiROUND(double v)
Round a floating point number to an integer using "round halfway cases away from zero".
Definition: common.h:106
void TransformCircleToPolygon(SHAPE_POLY_SET &aCornerBuffer, wxPoint aCenter, int aRadius, int aCircleToSegmentsCount)
Function TransformCircleToPolygon convert a circle to a polygon, using multiple straight lines...
void TransformOvalClearanceToPolygon(SHAPE_POLY_SET &aCornerBuffer, wxPoint aStart, wxPoint aEnd, int aWidth, int aCircleToSegmentsCount, double aCorrectionFactor)
convert a oblong shape to a polygon, using multiple segments It is similar to TransformRoundedEndsSeg...
int m_Width
Thickness of track, or via diameter.
Definition: class_track.h:341
wxPoint m_End
Line end point.
Definition: class_track.h:343
class VIA, a via (like a track segment on a copper layer)
Definition: typeinfo.h:96
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 209 of file base_struct.h.

References EDA_ITEM::m_StructType.

Referenced by Abort_Move_ModuleOutline(), abortMoveBitmap(), abortMoveItem(), AbortPinMove(), MODULE::Add(), CN_CLUSTER::Add(), BOARD::Add(), CN_CONNECTIVITY_ALGO::Add(), PCB_EDIT_FRAME::Add45DegreeSegment(), SCH_SCREEN::addConnectedItemsToBlock(), POINT_EDITOR::addCorner(), POINT_EDITOR::addCornerCondition(), SCH_EDIT_FRAME::addCurrentItemToList(), AddMenusForComponent(), AddMenusForEditComponent(), SCH_SHEET::AddPin(), ALIGN_DISTRIBUTE_TOOL::AlignBottom(), ALIGN_DISTRIBUTE_TOOL::AlignCenterX(), ALIGN_DISTRIBUTE_TOOL::AlignCenterY(), ALIGN_DISTRIBUTE_TOOL::AlignTop(), PCB_EDIT_FRAME::Attribut_Track(), PCB_EDIT_FRAME::Begin_Route(), SCH_EDIT_FRAME::BeginSegment(), PCB_EDIT_FRAME::Block_Delete(), PCB_EDIT_FRAME::Block_Duplicate(), PCB_EDIT_FRAME::Block_Flip(), PCB_EDIT_FRAME::Block_Move(), PCB_EDIT_FRAME::Block_Rotate(), HIERARCHY_NAVIG_DLG::buildHierarchyTree(), SCH_SCREENS::buildScreenList(), SCH_SHEET_LIST::BuildSheetList(), calcArea(), calcMaxArea(), SCH_NO_CONNECT::CanConnect(), SCH_JUNCTION::CanConnect(), SCH_BUS_WIRE_ENTRY::CanConnect(), SCH_LINE::CanConnect(), SCH_BUS_BUS_ENTRY::CanConnect(), SCH_LABEL::CanConnect(), SCH_GLOBALLABEL::CanConnect(), SCH_HIERLABEL::CanConnect(), SCH_SHEET::CanConnect(), SCH_COMPONENT::CanConnect(), ROUTER_TOOL::CanInlineDrag(), DIALOG_EXCHANGE_FOOTPRINTS::changeSameFootprints(), SCH_SCREENS::ChangeSymbolLibNickname(), SCH_EDIT_FRAME::CheckListConnections(), CN_VISITOR::checkZoneItemConnection(), EDGE_MODULE::ClassOf(), BOARD_CONNECTED_ITEM::ClassOf(), TEXTE_PCB::ClassOf(), TEXTE_MODULE::ClassOf(), DRAWSEGMENT::ClassOf(), TRACK::ClassOf(), NETINFO_ITEM::ClassOf(), MODULE::ClassOf(), D_PAD::ClassOf(), BOARD::ClassOf(), ClassOf(), SCH_SHEET::CleanupSheet(), Collect_TrackSegmentsToDrag(), LIB_BEZIER::compare(), LIB_CIRCLE::compare(), LIB_RECTANGLE::compare(), LIB_POLYLINE::compare(), LIB_TEXT::compare(), LIB_ARC::compare(), LIB_FIELD::compare(), LIB_PIN::compare(), SCH_SHEET::ComponentCount(), GRID_HELPER::computeAnchors(), SCH_SCREEN::CountConnectedItems(), SCH_SHEET::CountSheets(), MODULE::CoverageRatio(), LIB_EDIT_FRAME::CreateGraphicItem(), CINFO3D_VISU::createLayers(), BOARD::CreateLockPoint(), SCH_EDIT_FRAME::CreateNewText(), CINFO3D_VISU::createNewTrack(), PCB_EDIT_FRAME::createPopupMenuForTracks(), CreateRoutesSection(), PCB_EDITOR_CONTROL::CrossProbeSchToPcb(), D_PAD::D_PAD(), FOOTPRINT_EDIT_FRAME::Delete_Edge_Module(), PCB_EDIT_FRAME::Delete_Segment_Edge(), SCH_SCREENS::DeleteAllMarkers(), SCH_SCREEN::DeleteItem(), LIB_EDIT_FRAME::deleteItem(), SCH_EDIT_FRAME::DeleteItem(), DeleteNullTrackSegments(), PYTHON_ACTION_PLUGINS::deregister_action(), DIALOG_SCH_EDIT_ONE_FIELD::DIALOG_SCH_EDIT_ONE_FIELD(), DIALOG_ERC::DisplayERC_MarkersList(), ALIGN_DISTRIBUTE_TOOL::doAlignLeft(), ALIGN_DISTRIBUTE_TOOL::doAlignRight(), DRC::doTrackDrc(), DRC::doTrackKeepoutDrc(), KIGFX::GERBVIEW_PAINTER::Draw(), KIGFX::PCB_PAINTER::Draw(), KIGFX::PCB_PAINTER::draw(), DrawMovePin(), DrawMovingBlockOutlines(), drawPickedItems(), CN_ITEM::Dump(), BOARD::Duplicate(), MODULE::Duplicate(), PCB_EDIT_FRAME::duplicateItems(), DuplicateItemsInList(), SCH_EDIT_FRAME::EditComponent(), SCH_EDIT_FRAME::EditComponentFieldText(), LIB_EDIT_FRAME::EditSymbolText(), SCH_EDIT_FRAME::EndSegment(), PCB_EDIT_FRAME::EraseRedundantTrack(), ExitSheet(), SCH_SCREEN::ExtractWires(), DRC::fillMarker(), find_vias_and_tracks_at(), SCH_EDIT_FRAME::FindComponentAndItem(), NETLIST_EXPORTER::findNextComponent(), NETLIST_EXPORTER::findNextComponentAndCreatePinList(), SCH_SHEET_PATH::FindNextItem(), SCH_SHEET_LIST::FindNextItem(), SCH_SHEET_PATH::FindPreviousItem(), SCH_SHEET_LIST::FindPreviousItem(), EDIT_TOOL::FootprintFilter(), FootprintWriteShape(), PCB_IO::Format(), PCB_IO::format(), FormatProbeItem(), POINT_EDITOR::get45DegConstrainer(), getAnchorPoint(), TRACK::GetBestInsertPoint(), BOARD_ITEM::GetBoard(), TRACK::GetBoundingBox(), BOARD_CONNECTED_ITEM::GetClearance(), KIGFX::PCB_RENDER_SETTINGS::GetColor(), NETLIST_OBJECT::GetComponentParent(), SCH_SCREEN::GetConnection(), SCH_TEXT::GetConnectionPoints(), SCH_TEXT::GetEndPoints(), SCH_SHEET::GetEndPoints(), GetFirstTrack(), GetFirstVia(), SCH_SCREEN::GetHierarchicalItems(), SCH_SCREENS::GetLibNicknames(), TEXTE_PCB::GetMsgPanelInfo(), SCH_TEXT::GetMsgPanelInfo(), BOARD_CONNECTED_ITEM::GetNetClass(), CONNECTIVITY_DATA::GetNetItems(), LIB_PART::GetNextDrawItem(), DRAWSEGMENT::GetParentModule(), SCH_SCREEN::GetPin(), LIB_PART::GetPin(), SCH_COMPONENT::GetPinPhysicalPosition(), getRect(), SELECTION::GetTopLeftItem(), LIB_EDIT_FRAME::GlobalSetPins(), SELECTION_TOOL::guessSelectionCandidates(), hash_eda(), SCH_SCREENS::HasNoFullyDefinedLibIds(), SCH_SHEET::HasUndefinedPins(), SCH_EDIT_FRAME::ImportSheetPin(), DIALOG_LABEL_EDITOR::InitDialog(), ROUTER_TOOL::InlineDrag(), SCH_COLLECTOR::Inspect(), GENERAL_COLLECTOR::Inspect(), SCH_FIND_COLLECTOR::Inspect(), PCB_LAYER_COLLECTOR::Inspect(), ARRAY_CREATOR::Invoke(), CN_ANCHOR::IsDangling(), SCH_TEXT::IsDanglingStateChanged(), SCH_COLLECTOR::IsNode(), TRACK::IsNull(), SCH_LINE::IsParallel(), SCH_SCREEN::IsTerminalPoint(), BOARD_ITEM::IsTrack(), itemIsIncludedByFilter(), CLIPBOARD_IO::Load(), PNS_PCBNEW_RULE_RESOLVER::localPadClearance(), SCH_EDIT_FRAME::LocateAndShowItem(), SCH_EDIT_FRAME::LocateItem(), SCH_SHEET::LocatePathOfScreen(), Magnetize(), EDIT_POINTS_FACTORY::Make(), SCH_SCREEN::MarkConnections(), CONNECTIVITY_DATA::MarkItemNetAsDirty(), CN_CONNECTIVITY_ALGO::markItemNetAsDirty(), MarkItemsInBloc(), BOARD::MarkTrace(), TRACKS_CLEANER::mergeCollinearSegmentIfPossible(), TRACKS_CLEANER::MergeCollinearTracks(), SCH_LINE::MergeOverlap(), FOOTPRINT_EDIT_FRAME::ModeditLocateAndDisplay(), moveItemWithMouseCursor(), MoveMarkedItems(), MoveMarkedItemsExactly(), ROUTER_TOOL::NeighboringSegmentFilter(), SCH_EDIT_FRAME::OnConvertTextType(), SCH_EDIT_FRAME::OnCopySchematicItemRequest(), SCH_EDIT_FRAME::OnDragItem(), SCH_EDIT_FRAME::OnEditItem(), FOOTPRINT_EDIT_FRAME::OnEditItemRequest(), PCB_EDIT_FRAME::OnEditItemRequest(), SCH_EDIT_FRAME::OnHotKey(), PCB_EDIT_FRAME::OnHotkeyCopyItem(), FOOTPRINT_EDIT_FRAME::OnHotkeyDeleteItem(), PCB_EDIT_FRAME::OnHotkeyDeleteItem(), FOOTPRINT_EDIT_FRAME::OnHotkeyDuplicateItem(), PCB_EDIT_FRAME::OnHotkeyDuplicateOrArrayItem(), FOOTPRINT_EDIT_FRAME::OnHotkeyEditItem(), PCB_EDIT_FRAME::OnHotkeyEditItem(), PCB_EDIT_FRAME::OnHotkeyFlipItem(), FOOTPRINT_EDIT_FRAME::OnHotkeyMoveItem(), PCB_EDIT_FRAME::OnHotkeyMoveItem(), FOOTPRINT_EDIT_FRAME::OnHotkeyMoveItemExact(), PCB_EDIT_FRAME::OnHotkeyPlaceItem(), FOOTPRINT_EDIT_FRAME::OnHotkeyRotateItem(), PCB_EDIT_FRAME::OnHotkeyRotateItem(), FOOTPRINT_EDIT_FRAME::OnLeftClick(), SCH_EDIT_FRAME::OnLeftClick(), LIB_EDIT_FRAME::OnLeftClick(), PCB_EDIT_FRAME::OnLeftClick(), SCH_EDIT_FRAME::OnLeftDClick(), LIB_EDIT_FRAME::OnLeftDClick(), PCB_EDIT_FRAME::OnLeftDClick(), SCH_EDIT_FRAME::OnMoveItem(), SCH_EDIT_FRAME::OnOpenLibraryEditor(), SCH_EDIT_FRAME::OnOrient(), FOOTPRINT_EDIT_FRAME::OnRightClick(), SCH_EDIT_FRAME::OnRightClick(), LIB_EDIT_FRAME::OnRightClick(), PCB_EDIT_FRAME::OnRightClick(), SCH_EDIT_FRAME::OnRotate(), SCH_EDIT_FRAME::OnSelectUnit(), SCH_LINE::operator<(), LIB_ITEM::operator<(), SCH_ITEM::operator<(), SCH_COMPONENT::operator<(), SCH_BITMAP::operator=(), SCH_SHEET::operator=(), SCH_COMPONENT::operator=(), LIB_ITEM::operator==(), OrCell_Trace(), SCH_EDIT_FRAME::OrientComponent(), BOARD_COMMIT::parentObject(), PCBNEW_CONTROL::PasteItemsFromClipboard(), SCH_EDIT_FRAME::PasteListOfItems(), PCB_BASE_FRAME::PcbGeneralLocateAndDisplay(), LIB_EDIT_FRAME::PlacePin(), SCH_FIELD::Plot(), BRDITEMS_PLOTTER::Plot_1_EdgeModule(), SCH_EDIT_FRAME::PrepareMoveItem(), GAL_ARRAY_CREATOR::prePushAction(), PCB_EDIT_FRAME::PrintPage(), FOOTPRINT_EDIT_FRAME::Process_Special_Functions(), LIB_EDIT_FRAME::Process_Special_Functions(), SCH_EDIT_FRAME::Process_Special_Functions(), PCB_EDIT_FRAME::Process_Special_Functions(), BOARD_COMMIT::Push(), PCB_BASE_EDIT_FRAME::PutDataInPreviousState(), RedrawWhileMovingCursor(), DIALOG_SYMBOL_REMAP::remapSymbolsToLibTable(), MODULE::Remove(), BOARD::Remove(), CN_CONNECTIVITY_ALGO::Remove(), POINT_EDITOR::removeCorner(), POINT_EDITOR::removeCornerCondition(), LIB_PART::RemoveDrawItem(), TRACKS_CLEANER::removeDuplicatesOfTrack(), SCH_SHEET::RemovePin(), FOOTPRINT_EDIT_FRAME::RemoveStruct(), PCB_EDIT_FRAME::RemoveStruct(), SCH_EDIT_FRAME::RepeatDrawItem(), LIB_EDIT_FRAME::RepeatPinItem(), SCH_SCREENS::ReplaceDuplicateTimeStamps(), SCH_SCREEN::ReplaceWires(), PCB_EDIT_FRAME::Reset_All_Tracks_And_Vias_To_Netclass_Values(), PCB_BASE_FRAME::ResetTextSize(), SCH_EDIT_FRAME::ReSizeSheet(), BOARD_COMMIT::Revert(), SCH_EDIT_FRAME::RotateField(), SCH_LEGACY_PLUGIN_CACHE::saveArc(), SCH_LEGACY_PLUGIN_CACHE::saveBezier(), SCH_LEGACY_PLUGIN_CACHE::saveCircle(), PCB_BASE_EDIT_FRAME::SaveCopyInUndoList(), SCH_LEGACY_PLUGIN_CACHE::saveField(), SCH_LEGACY_PLUGIN_CACHE::savePin(), SCH_LEGACY_PLUGIN_CACHE::savePolyLine(), SCH_LEGACY_PLUGIN_CACHE::saveRectangle(), SCH_LEGACY_PLUGIN_CACHE::saveText(), SCH_EDIT_FRAME::SaveUndoItemInUndoList(), SCH_EDIT_FRAME::SchematicCleanUp(), SCH_SHEET::SearchHierarchy(), SELECTION_TOOL::select(), SELECTION_TOOL::selectable(), SCH_SCREEN::SelectBlockItems(), PCB_EDIT_FRAME::SelectHighLight(), SELECTION_TOOL::selectVisually(), ITEM_PICKER::SetItem(), SetSchItemParent(), DIALOG_LABEL_EDITOR::SetTitle(), PCB_EDIT_FRAME::SetTrackSegmentWidth(), PCB_EDIT_FRAME::Show_1_Ratsnest(), Show_MoveNode(), ShowClearance(), ShowNewTrackWhenMovingCursor(), SortByTimeStamp(), PCB_EDIT_FRAME::Start_DragTrackSegmentAndKeepSlope(), LIB_EDIT_FRAME::StartMoveDrawSymbol(), PCB_EDIT_FRAME::StartMoveOneNodeOrSegment(), SCH_JUNCTION::SwapData(), SCH_NO_CONNECT::SwapData(), SCH_BITMAP::SwapData(), PCB_TARGET::SwapData(), SCH_FIELD::SwapData(), SCH_SHEET_PIN::SwapData(), TEXTE_PCB::SwapData(), DIMENSION::SwapData(), DRAWSEGMENT::SwapData(), TRACK::SwapData(), SCH_SHEET::SwapData(), SCH_COMPONENT::SwapData(), SwapData(), ZONE_CONTAINER::SwapData(), MODULE::SwapData(), D_PAD::SwapData(), SwapItemData(), PCB_EDIT_FRAME::SwitchLayer(), TestDuplicateSheetNames(), TRACKS_CLEANER::testTrackEndpointDangling(), TEXTE_MODULE::TEXTE_MODULE(), DIALOG_LABEL_EDITOR::TextPropertiesAccept(), TraceSegmentPcb(), SELECTION_TOOL::unselectVisually(), SCH_SHEET_PATH::UpdateAllScreenReferences(), DIALOG_SCH_EDIT_ONE_FIELD::UpdateField(), POINT_EDITOR::updateItem(), POINT_EDITOR::updatePoints(), PCB_BRIGHT_BOX::ViewDraw(), TRACK::Visit(), GERBER_DRAW_ITEM::Visit(), EDA_ITEM::Visit(), SCH_SHEET::Visit(), and SCH_COMPONENT::Visit().

210  {
211  return m_StructType;
212  }
KICAD_T m_StructType
Run time identification, keep private so it can never be changed after a constructor sets it...
Definition: base_struct.h:171
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.

References EDA_ITEM::GetList().

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(), PCB_EDIT_FRAME::EraseRedundantTrack(), BOARD::MarkTrace(), and BOARD_ITEM::SetLocked().

55 {
57  wxASSERT( list );
58 
59  if( list )
60  list->Remove( this );
61 }
DHEAD * GetList() const
Definition: base_struct.h:220
const BOX2I TRACK::ViewBBox ( ) const
overridevirtualinherited

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

Returns
BOX2I - the current bounding box

Reimplemented from EDA_ITEM.

Definition at line 808 of file class_track.cpp.

References TRACK::GetBoundingBox(), TRACK::GetClearance(), and BOX2< Vec >::Inflate().

Referenced by TRACK::GetClass().

809 {
810  BOX2I bbox( GetBoundingBox() );
811  bbox.Inflate( 2 * GetClearance() );
812  return bbox;
813 }
const EDA_RECT GetBoundingBox() const override
Function GetBoundingBox returns the orthogonal, bounding box of this object for display purposes...
virtual int GetClearance(BOARD_CONNECTED_ITEM *aItem=NULL) const override
Function GetClearance returns the clearance in internal units.
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
aLayercurrent drawing layer
aViewpointer 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::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.

References KIGFX::VIEW_ITEM::ViewGetLayers().

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

117  {}
void VIA::ViewGetLayers ( int  aLayers[],
int &  aCount 
) const
overridevirtual

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
aCountnumber of layer indices in aLayers[]

Reimplemented from TRACK.

Definition at line 1027 of file class_track.cpp.

References GetViaType(), LAYER_GP_OVERLAY, LAYER_VIA_BBLIND, LAYER_VIA_MICROVIA, LAYER_VIA_THROUGH, LAYER_VIAS_HOLES, LAYER_VIAS_NETNAMES, m_BottomLayer, BOARD_ITEM::m_Layer, VIA_BLIND_BURIED, VIA_MICROVIA, and VIA_THROUGH.

1028 {
1029  aLayers[0] = LAYER_VIAS_HOLES;
1030  aLayers[1] = LAYER_VIAS_NETNAMES;
1031  aCount = 3;
1032 
1033  // Just show it on common via & via holes layers
1034  switch( GetViaType() )
1035  {
1036  case VIA_THROUGH:
1037  aLayers[2] = LAYER_VIA_THROUGH;
1038  break;
1039 
1040  case VIA_BLIND_BURIED:
1041  aLayers[2] = LAYER_VIA_BBLIND;
1042  aLayers[3] = m_Layer;
1043  aLayers[4] = m_BottomLayer;
1044  aCount += 2;
1045  break;
1046 
1047  case VIA_MICROVIA:
1048  aLayers[2] = LAYER_VIA_MICROVIA;
1049  break;
1050 
1051  default:
1052  aLayers[2] = LAYER_GP_OVERLAY;
1053  wxASSERT( false );
1054  break;
1055  }
1056 }
to draw blind/buried vias
to draw via holes (pad holes do not use this layer)
PCB_LAYER_ID m_Layer
VIATYPE_T GetViaType() const
Definition: class_track.h:460
to draw usual through hole vias
PCB_LAYER_ID m_BottomLayer
The bottom layer of the via (the top layer is in m_Layer)
Definition: class_track.h:504
general purpose overlay
unsigned int VIA::ViewGetLOD ( int  aLayer,
KIGFX::VIEW aView 
) const
overridevirtual

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
aLayercurrent drawing layer
aViewpointer 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 from TRACK.

Definition at line 1059 of file class_track.cpp.

References BOARD_ITEM::GetBoard(), GetLayerSet(), BOARD::GetVisibleLayers(), and max.

1060 {
1061  BOARD* board = GetBoard();
1062 
1063  // Only draw the via if at least one of the layers it crosses is being displayed
1064  if( board && ( board->GetVisibleLayers() & GetLayerSet() ).any() )
1065  return 0;
1066 
1068 }
virtual LSET GetLayerSet() const override
Function GetLayerSet returns a "layer mask", which is a bitmap of all layers on which the TRACK segme...
#define max(a, b)
Definition: auxiliary.h:86
Class BOARD holds information pertinent to a Pcbnew printed circuit board.
Definition: class_board.h:169
LSET GetVisibleLayers() const
Function GetVisibleLayers is a proxy function that calls the correspondent function in m_BoardSetting...
virtual BOARD * GetBoard() const
Function GetBoard returns the BOARD in which this BOARD_ITEM resides, or NULL if none.
SEARCH_RESULT TRACK::Visit ( INSPECTOR  inspector,
void *  testData,
const KICAD_T  scanTypes[] 
)
overridevirtualinherited

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
inspectorAn INSPECTOR instance to use in the inspection.
testDataArbitrary data used by the inspector.
scanTypesWhich 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 from EDA_ITEM.

Definition at line 361 of file class_track.cpp.

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

Referenced by TRACK::GetLength().

362 {
363  KICAD_T stype = *scanTypes;
364 
365  // If caller wants to inspect my type
366  if( stype == Type() )
367  {
368  if( SEARCH_QUIT == inspector( this, testData ) )
369  return SEARCH_QUIT;
370  }
371 
372  return SEARCH_CONTINUE;
373 }
KICAD_T Type() const
Function Type()
Definition: base_struct.h:209
KICAD_T
Enum KICAD_T is the set of class identification values, stored in EDA_ITEM::m_StructType.
Definition: typeinfo.h:78

Member Data Documentation

PCB_LAYER_ID VIA::m_BottomLayer
private

The bottom layer of the via (the top layer is in m_Layer)

Definition at line 504 of file class_track.h.

Referenced by BottomLayer(), GetLayerSet(), LayerPair(), SanitizeLayers(), SetBottomLayer(), SetLayerPair(), VIA(), and ViewGetLayers().

int VIA::m_Drill
private

Definition at line 508 of file class_track.h.

Referenced by GetDrillValue().

STATUS_FLAGS EDA_ITEM::m_Flags
protectedinherited

Flag bits for editing and other uses.

Definition at line 186 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_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(), 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(), GERBER_DRAW_ITEM::HitTest(), SCH_COMPONENT::HitTest(), LIB_ITEM::InEditMode(), EDA_ITEM::initVars(), SCH_ITEM::IsConnected(), SCH_LINE::Move(), EDA_ITEM::operator=(), SCH_COMPONENT::SCH_COMPONENT(), LIB_PIN::SetConversion(), 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().

bool EDA_ITEM::m_forceVisible
protectedinherited

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

Definition at line 183 of file base_struct.h.

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

DHEAD* EDA_ITEM::m_List
protectedinherited

which DLIST I am on.

Definition at line 177 of file base_struct.h.

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

NETINFO_ITEM* BOARD_CONNECTED_ITEM::m_netinfo
protectedinherited
double TRACK::m_Param
inherited

Definition at line 93 of file class_track.h.

Referenced by TRACK::GetEndSegments(), and TRACK::TRACK().

VIATYPE_T VIA::m_ViaType
private

Definition at line 506 of file class_track.h.

EDA_ITEM* EDA_ITEM::Pback
protectedinherited

previous in linked list

Definition at line 176 of file base_struct.h.

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


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