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...
 
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 const BOX2I ViewBBox () const override
 Function ViewBBox() returns the bounding box of the item covering all its layers. More...
 
virtual void ViewDraw (int aLayer, VIEW *aView) const
 Function ViewDraw() Draws the parts of the object belonging to layer aLayer. More...
 
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 377 of file class_track.h.

Constructor & Destructor Documentation

VIA::VIA ( BOARD_ITEM aParent)

Definition at line 157 of file class_track.cpp.

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

Referenced by Clone().

157  :
158  TRACK( aParent, PCB_VIA_T )
159 {
162  SetDrillDefault();
163 }
void SetViaType(VIATYPE_T aViaType)
Definition: class_track.h:456
PCB_LAYER_ID m_BottomLayer
The bottom layer of the via (the top layer is in m_Layer)
Definition: class_track.h:499
void SetDrillDefault()
Function SetDrillDefault sets the drill value for vias to the default value UNDEFINED_DRILL_DIAMETER...
Definition: class_track.h:484
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:95

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::GetTrack(), and Magnetize().

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

Definition at line 477 of file class_track.cpp.

References m_BottomLayer.

Referenced by DIALOG_TRACK_VIA_PROPERTIES::DIALOG_TRACK_VIA_PROPERTIES().

478 {
479  return m_BottomLayer;
480 }
PCB_LAYER_ID m_BottomLayer
The bottom layer of the via (the top layer is in m_Layer)
Definition: class_track.h:499
static bool VIA::ClassOf ( const EDA_ITEM aItem)
inlinestatic

Definition at line 382 of file class_track.h.

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

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

Definition at line 262 of file base_struct.h.

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

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

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

Definition at line 283 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_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(), SCH_EAGLE_PLUGIN::loadSheet(), 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(), PCBNEW_CONTROL::placeBoardItems(), 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().

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

Definition at line 261 of file base_struct.h.

References EDA_ITEM::ClearFlags(), and HIGHLIGHTED.

261 { ClearFlags( HIGHLIGHTED ); }
#define HIGHLIGHTED
item is drawn in normal colors, when the rest is darkened
Definition: base_struct.h:150
void ClearFlags(STATUS_FLAGS aMask=EDA_ITEM_ALL_FLAGS)
Definition: base_struct.h:283
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 166 of file class_track.cpp.

References VIA().

167 {
168  return new VIA( *this );
169 }
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 812 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.

813 {
814  wxCHECK_RET( panel != NULL, wxT( "VIA::Draw panel cannot be NULL." ) );
815 
816  int radius;
817  PCB_LAYER_ID curr_layer = ( (PCB_SCREEN*) panel->GetScreen() )->m_Active_Layer;
818 
819  int fillvia = 0;
820  PCB_BASE_FRAME* frame = (PCB_BASE_FRAME*) panel->GetParent();
821  PCB_SCREEN* screen = frame->GetScreen();
822  auto displ_opts = (PCB_DISPLAY_OPTIONS*)( frame->GetDisplayOptions() );
823 
824  if( displ_opts->m_DisplayViaFill == FILLED )
825  fillvia = 1;
826 
827  GRSetDrawMode( aDC, aDrawMode );
828 
829  BOARD * brd = GetBoard();
831 
832  if( brd->IsElementVisible( LAYER_VIAS + GetViaType() ) == false
833  && !( aDrawMode & GR_HIGHLIGHT ) )
834  return;
835 
836  // Only draw the via if at least one of the layers it crosses is being displayed
837  if( !( brd->GetVisibleLayers() & GetLayerSet() ).any() )
838  return;
839 
840  if( displ_opts->m_ContrastModeDisplay )
841  {
842  if( !IsOnLayer( curr_layer ) )
843  color = COLOR4D( DARKDARKGRAY );
844  }
845 
846  if( ( aDrawMode & GR_HIGHLIGHT ) && !( aDrawMode & GR_AND ) )
847  color.SetToLegacyHighlightColor();
848 
849  color.a = 0.588;
850 
851 
852  radius = m_Width >> 1;
853  // for small via size on screen (radius < 4 pixels) draw a simplified shape
854 
855  int radius_in_pixels = aDC->LogicalToDeviceXRel( radius );
856 
857  bool fast_draw = false;
858 
859  // Vias are drawn as a filled circle or a double circle. The hole will be drawn later
860  int drill_radius = GetDrillValue() / 2;
861 
862  int inner_radius = radius - aDC->DeviceToLogicalXRel( 2 );
863 
864  if( radius_in_pixels < MIN_VIA_DRAW_SIZE )
865  {
866  fast_draw = true;
867  fillvia = false;
868  }
869 
870  if( fillvia )
871  {
872  GRFilledCircle( panel->GetClipBox(), aDC, m_Start + aOffset, radius, color );
873  }
874  else
875  {
876  GRCircle( panel->GetClipBox(), aDC, m_Start + aOffset, radius, 0, color );
877 
878  if ( fast_draw )
879  return;
880 
881  GRCircle( panel->GetClipBox(), aDC, m_Start + aOffset, inner_radius, 0, color );
882  }
883 
884  if( fillvia )
885  {
886  bool blackpenstate = false;
887 
888  if( screen->m_IsPrinting )
889  {
890  blackpenstate = GetGRForceBlackPenState();
891  GRForceBlackPen( false );
892  color = WHITE;
893  }
894  else
895  {
896  color = BLACK; // or DARKGRAY;
897  }
898 
899  if( (aDrawMode & GR_XOR) == 0)
900  GRSetDrawMode( aDC, GR_COPY );
901 
902  // Draw hole if the radius is > 1pixel.
903  if( aDC->LogicalToDeviceXRel( drill_radius ) > 1 )
904  GRFilledCircle( panel->GetClipBox(), aDC, m_Start.x + aOffset.x,
905  m_Start.y + aOffset.y, drill_radius, 0, color, color );
906 
907  if( screen->m_IsPrinting )
908  GRForceBlackPen( blackpenstate );
909  }
910  else
911  {
912  if( drill_radius < inner_radius ) // We can show the via hole
913  GRCircle( panel->GetClipBox(), aDC, m_Start + aOffset, drill_radius, 0, color );
914  }
915 
916  if( ShowClearance( displ_opts, this ) )
917  {
918  GRCircle( panel->GetClipBox(), aDC, m_Start + aOffset, radius + GetClearance(), 0, color );
919  }
920 
921  // for Micro Vias, draw a partial cross : X on component layer, or + on copper layer
922  // (so we can see 2 superimposed microvias ):
923  if( GetViaType() == VIA_MICROVIA )
924  {
925  int ax, ay, bx, by;
926 
927  if( IsOnLayer( B_Cu ) )
928  {
929  ax = radius; ay = 0;
930  bx = drill_radius; by = 0;
931  }
932  else
933  {
934  ax = ay = (radius * 707) / 1000;
935  bx = by = (drill_radius * 707) / 1000;
936  }
937 
938  // lines '|' or '\'
939  GRLine( panel->GetClipBox(), aDC, m_Start.x + aOffset.x - ax,
940  m_Start.y + aOffset.y - ay,
941  m_Start.x + aOffset.x - bx,
942  m_Start.y + aOffset.y - by, 0, color );
943  GRLine( panel->GetClipBox(), aDC, m_Start.x + aOffset.x + bx,
944  m_Start.y + aOffset.y + by,
945  m_Start.x + aOffset.x + ax,
946  m_Start.y + aOffset.y + ay, 0, color );
947 
948  // lines - or '/'
949  GRLine( panel->GetClipBox(), aDC, m_Start.x + aOffset.x + ay,
950  m_Start.y + aOffset.y - ax,
951  m_Start.x + aOffset.x + by,
952  m_Start.y + aOffset.y - bx, 0, color );
953  GRLine( panel->GetClipBox(), aDC, m_Start.x + aOffset.x - by,
954  m_Start.y + aOffset.y + bx,
955  m_Start.x + aOffset.x - ay,
956  m_Start.y + aOffset.y + ax, 0, color );
957  }
958 
959  // for Buried Vias, draw a partial line : orient depending on layer pair
960  // (so we can see superimposed buried vias ):
961  if( GetViaType() == VIA_BLIND_BURIED )
962  {
963  int ax = 0, ay = radius, bx = 0, by = drill_radius;
964  PCB_LAYER_ID layer_top, layer_bottom;
965 
966  LayerPair( &layer_top, &layer_bottom );
967 
968  // lines for the top layer
969  RotatePoint( &ax, &ay, layer_top * 3600.0 / brd->GetCopperLayerCount( ) );
970  RotatePoint( &bx, &by, layer_top * 3600.0 / brd->GetCopperLayerCount( ) );
971  GRLine( panel->GetClipBox(), aDC, m_Start.x + aOffset.x - ax,
972  m_Start.y + aOffset.y - ay,
973  m_Start.x + aOffset.x - bx,
974  m_Start.y + aOffset.y - by, 0, color );
975 
976  // lines for the bottom layer
977  ax = 0; ay = radius; bx = 0; by = drill_radius;
978  RotatePoint( &ax, &ay, layer_bottom * 3600.0 / brd->GetCopperLayerCount( ) );
979  RotatePoint( &bx, &by, layer_bottom * 3600.0 / brd->GetCopperLayerCount( ) );
980  GRLine( panel->GetClipBox(), aDC, m_Start.x + aOffset.x - ax,
981  m_Start.y + aOffset.y - ay,
982  m_Start.x + aOffset.x - bx,
983  m_Start.y + aOffset.y - by, 0, color );
984  }
985 
986  // Display the short netname:
988  return;
989 
990  if( displ_opts->m_DisplayNetNamesMode == 0 || displ_opts->m_DisplayNetNamesMode == 1 )
991  return;
992 
993  NETINFO_ITEM* net = GetNet();
994 
995  if( net == NULL )
996  return;
997 
998  int len = net->GetShortNetname().Len();
999 
1000  if( len > 0 )
1001  {
1002  // calculate a good size for the text
1003  int tsize = m_Width / len;
1004 
1005  if( aDC->LogicalToDeviceXRel( tsize ) >= MIN_TEXT_SIZE )
1006  {
1007  tsize = (tsize * 7) / 10; // small reduction to give a better look, inside via
1008 
1009  if( (aDrawMode & GR_XOR) == 0 )
1010  GRSetDrawMode( aDC, GR_COPY );
1011 
1012  EDA_RECT* clipbox = panel->GetClipBox();
1013  DrawGraphicHaloText( clipbox, aDC, m_Start,
1014  color, WHITE, BLACK, net->GetShortNetname(), 0,
1015  wxSize( tsize, tsize ),
1017  tsize / 7, false, false );
1018  }
1019  }
1020 }
#define MIN_VIA_DRAW_SIZE
Definition: class_track.h:61
wxPoint m_Start
Line start point.
Definition: class_track.h:337
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:54
void RotatePoint(int *pX, int *pY, double angle)
Definition: trigo.cpp:317
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 * 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:336
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:455
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:181
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:194
PCB_SCREEN * GetScreen() const override
Function GetScreen returns a pointer to a BASE_SCREEN or one of its derivatives.
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), PLOTTER *aPlotter)
Draw graphic text with a border, so that it can be read on different backgrounds. ...
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 577 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().

579 {
580  if( ! panel )
581  return;
582 
583  /* we must filter tracks, to avoid a lot of texts.
584  * - only tracks with a length > 10 * thickness are eligible
585  * and, of course, if we are not printing the board
586  */
587  auto displ_opts = (PCB_DISPLAY_OPTIONS*)( panel->GetDisplayOptions() );
588 
589  if( displ_opts->m_DisplayNetNamesMode == 0 || displ_opts->m_DisplayNetNamesMode == 1 )
590  return;
591 
592  #define THRESHOLD 10
593 
594  int len = KiROUND( GetLineLength( m_Start, m_End ) );
595 
596  if( len < THRESHOLD * m_Width )
597  return;
598 
599  // no room to display a text inside track
600  if( aDC->LogicalToDeviceXRel( m_Width ) < MIN_TEXT_SIZE )
601  return;
602 
604  return;
605 
606  NETINFO_ITEM* net = GetNet();
607 
608  if( net == NULL )
609  return;
610 
611  int textlen = net->GetShortNetname().Len();
612 
613  if( textlen > 0 )
614  {
615  // calculate a good size for the text
616  int tsize = std::min( m_Width, len / textlen );
617  int dx = m_End.x - m_Start.x ;
618  int dy = m_End.y - m_Start.y ;
619  wxPoint tpos = m_Start + m_End;
620  tpos.x /= 2;
621  tpos.y /= 2;
622 
623  // Calculate angle: if the track segment is vertical, angle = 90 degrees
624  // If horizontal 0 degrees, otherwise compute it
625  double angle; // angle is in 0.1 degree
626 
627  if( dy == 0 ) // Horizontal segment
628  {
629  angle = 0;
630  }
631  else
632  {
633  if( dx == 0 ) // Vertical segment
634  {
635  angle = 900;
636  }
637  else
638  {
639  /* atan2 is *not* the solution here, since it can give upside
640  down text. We want to work only in the first and fourth quadrant */
641  angle = RAD2DECIDEG( -atan( double( dy ) / double( dx ) ) );
642  }
643  }
644 
645  PCB_LAYER_ID curr_layer = ( (PCB_SCREEN*) panel->GetScreen() )->m_Active_Layer;
646 
647  if( ( aDC->LogicalToDeviceXRel( tsize ) >= MIN_TEXT_SIZE )
648  && ( !(!IsOnLayer( curr_layer )&& displ_opts->m_ContrastModeDisplay) ) )
649  {
650  if( (aDrawMode & GR_XOR) == 0 )
651  GRSetDrawMode( aDC, GR_COPY );
652 
653  tsize = (tsize * 7) / 10; // small reduction to give a better look
654  DrawGraphicHaloText( panel->GetClipBox(), aDC, tpos,
655  aBgColor, BLACK, WHITE, net->GetShortNetname(), angle,
656  wxSize( tsize, tsize ),
658  tsize / 7,
659  false, false );
660  }
661  }
662 }
wxPoint m_Start
Line start point.
Definition: class_track.h:337
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)
KiROUND rounds a floating point number to an int using "round halfway cases away from zero"...
Definition: common.h:107
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
#define MIN_TEXT_SIZE
int m_Width
Thickness of track, or via diameter.
Definition: class_track.h:336
#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:338
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:194
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), PLOTTER *aPlotter)
Draw graphic text with a border, so that it can be read on different backgrounds. ...
Definition: colors.h:49
Definition: colors.h:45
void * GetDisplayOptions()
Function GetDisplayOptions A way to pass info to draw functions.
Definition: draw_panel.cpp:188
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 270 of file class_board_item.h.

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

271  {
272  Flip( wxPoint( aCentre.x, aCentre.y ) );
273  }
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 358 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.

359 {
360  m_Start.y = aCentre.y - (m_Start.y - aCentre.y);
361  m_End.y = aCentre.y - (m_End.y - aCentre.y);
362 
363  if( GetViaType() != VIA_THROUGH )
364  {
365  int copperLayerCount = GetBoard()->GetCopperLayerCount();
366  PCB_LAYER_ID top_layer;
367  PCB_LAYER_ID bottom_layer;
368  LayerPair( &top_layer, &bottom_layer );
369  top_layer = FlipLayer( top_layer, copperLayerCount );
370  bottom_layer = FlipLayer( bottom_layer, copperLayerCount );
371  SetLayerPair( top_layer, bottom_layer );
372  }
373 }
wxPoint m_Start
Line start point.
Definition: class_track.h:337
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:455
wxPoint m_End
Line end point.
Definition: class_track.h:338
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 the begging 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 item found in the linked list (or NULL if no track)

Definition at line 496 of file class_track.cpp.

References BOARD_CONNECTED_ITEM::GetNetCode(), BOARD::m_Track, BOARD::m_Zone, TRACK::Next(), PCB_ZONE_T, and EDA_ITEM::Type().

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

497 {
498  TRACK* track;
499 
500  if( Type() == PCB_ZONE_T )
501  track = aPcb->m_Zone;
502  else
503  track = aPcb->m_Track;
504 
505  for( ; track; track = track->Next() )
506  {
507  if( GetNetCode() <= track->GetNetCode() )
508  return track;
509  }
510 
511  return NULL;
512 }
KICAD_T Type() const
Function Type()
Definition: base_struct.h:227
DLIST< SEGZONE > m_Zone
Definition: class_board.h:247
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:246
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(), TEXTE_PCB::Draw(), PCB_TARGET::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::GetBoundingBox(), 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(), and 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:227
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 289 of file class_track.cpp.

References TRACK::GetClearance(), 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(), and TRACK::GetEndPoint().

290 {
291  // end of track is round, this is its radius, rounded up
292  int radius;
293 
294  int ymax;
295  int xmax;
296 
297  int ymin;
298  int xmin;
299 
300  if( Type() == PCB_VIA_T )
301  {
302  // Because vias are sometimes drawn larger than their m_Width would
303  // provide, erasing them using a dirty rect must also compensate for this
304  // possibility (that the via is larger on screen than its m_Width would provide).
305  // Because it is cheap to return a larger BoundingBox, do it so that
306  // the via gets erased properly. Do not divide width by 2 for this reason.
307  radius = m_Width;
308 
309  ymax = m_Start.y;
310  xmax = m_Start.x;
311 
312  ymin = m_Start.y;
313  xmin = m_Start.x;
314  }
315  else
316  {
317  radius = ( m_Width + 1 ) / 2;
318 
319  ymax = std::max( m_Start.y, m_End.y );
320  xmax = std::max( m_Start.x, m_End.x );
321 
322  ymin = std::min( m_Start.y, m_End.y );
323  xmin = std::min( m_Start.x, m_End.x );
324  }
325 
326  // + 1 is for the clearance line itself.
327  radius += GetClearance() + 1;
328 
329  ymax += radius;
330  xmax += radius;
331 
332  ymin -= radius;
333  xmin -= radius;
334 
335  // return a rectangle which is [pos,dim) in nature. therefore the +1
336  EDA_RECT ret( wxPoint( xmin, ymin ), wxSize( xmax - xmin + 1, ymax - ymin + 1 ) );
337 
338  return ret;
339 }
KICAD_T Type() const
Function Type()
Definition: base_struct.h:227
wxPoint m_Start
Line start point.
Definition: class_track.h:337
int m_Width
Thickness of track, or via diameter.
Definition: class_track.h:336
wxPoint m_End
Line end point.
Definition: class_track.h:338
virtual int GetClearance(BOARD_CONNECTED_ITEM *aItem=NULL) const override
Function GetClearance returns the clearance in internal units.
#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(), DIALOG_CREATE_ARRAY::ARRAY_CIRCULAR_OPTIONS::TransformItem(), and DRAWSEGMENT::TransformShapeWithClearanceToPolygon().

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 434 of file class_track.h.

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

435  {
436  return wxT( "VIA" );
437  }
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 225 of file class_track.cpp.

References BOARD_CONNECTED_ITEM::GetClearance().

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

226 {
227  // Currently tracks have no specific clearance parameter on a per track or per
228  // segment basis. The NETCLASS clearance is used.
229  return BOARD_CONNECTED_ITEM::GetClearance( aItem );
230 }
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 470 of file class_track.h.

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

470 { return m_Drill; }
int m_Drill
Definition: class_track.h:503
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 233 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().

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

Definition at line 544 of file class_track.cpp.

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

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

545 {
546  TRACK* NextS, * Track = this;
547  int ii = 0;
548 
549  if( Track == NULL )
550  return NULL;
551 
552  if( NetCode == -1 )
553  NetCode = GetNetCode();
554 
555  while( Track != NULL )
556  {
557  NextS = (TRACK*) Track->Pnext;
558 
559  if( Track->GetNetCode() == NetCode )
560  ii++;
561 
562  if( NextS == NULL )
563  break;
564 
565  if( NextS->GetNetCode() > NetCode )
566  break;
567 
568  Track = NextS;
569  }
570 
571  if( ii )
572  return Track;
573  else
574  return NULL;
575 }
int GetNetCode() const
Function GetNetCode.
EDA_ITEM * Pnext
next in linked list
Definition: base_struct.h:193
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:337
wxPoint m_End
Line end point.
Definition: class_track.h:338
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 1474 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().

1475 {
1476  TRACK* Track, * via, * segm, * TrackListEnd;
1477  int NbEnds, ii, ok = 0;
1478  LSET layerMask;
1479 
1480  if( aCount <= 1 )
1481  {
1482  *aStartTrace = *aEndTrace = this;
1483  return 1;
1484  }
1485 
1486  // Calculation of the limit analysis.
1487  *aStartTrace = *aEndTrace = NULL;
1488  TrackListEnd = Track = this;
1489  ii = 0;
1490 
1491  for( ; ( Track != NULL ) && ( ii < aCount ); ii++, Track = Track->Next() )
1492  {
1493  TrackListEnd = Track;
1494  Track->m_Param = 0;
1495  }
1496 
1497  // Calculate the extremes.
1498  NbEnds = 0;
1499  Track = this;
1500  ii = 0;
1501 
1502  for( ; ( Track != NULL ) && ( ii < aCount ); ii++, Track = Track->Next() )
1503  {
1504  if( Track->Type() == PCB_VIA_T )
1505  continue;
1506 
1507  layerMask = Track->GetLayerSet();
1508  via = GetVia( TrackListEnd, Track->m_Start, layerMask );
1509 
1510  if( via )
1511  {
1512  layerMask |= via->GetLayerSet();
1513  via->SetState( BUSY, true );
1514  }
1515 
1516  Track->SetState( BUSY, true );
1517  segm = ::GetTrack( this, TrackListEnd, Track->m_Start, layerMask );
1518  Track->SetState( BUSY, false );
1519 
1520  if( via )
1521  via->SetState( BUSY, false );
1522 
1523  if( segm == NULL )
1524  {
1525  switch( NbEnds )
1526  {
1527  case 0:
1528  *aStartTrace = Track; NbEnds++;
1529  break;
1530 
1531  case 1:
1532  int BeginPad, EndPad;
1533  *aEndTrace = Track;
1534 
1535  // Swap ox, oy with fx, fy
1536  BeginPad = Track->GetState( BEGIN_ONPAD );
1537  EndPad = Track->GetState( END_ONPAD );
1538 
1539  Track->SetState( BEGIN_ONPAD | END_ONPAD, false );
1540 
1541  if( BeginPad )
1542  Track->SetState( END_ONPAD, true );
1543 
1544  if( EndPad )
1545  Track->SetState( BEGIN_ONPAD, true );
1546 
1547  std::swap( Track->m_Start, Track->m_End );
1548  std::swap( Track->start, Track->end );
1549  ok = 1;
1550  return ok;
1551  }
1552  }
1553 
1554  layerMask = Track->GetLayerSet();
1555  via = GetVia( TrackListEnd, Track->m_End, layerMask );
1556 
1557  if( via )
1558  {
1559  layerMask |= via->GetLayerSet();
1560  via->SetState( BUSY, true );
1561  }
1562 
1563  Track->SetState( BUSY, true );
1564  segm = ::GetTrack( this, TrackListEnd, Track->m_End, layerMask );
1565  Track->SetState( BUSY, false );
1566 
1567  if( via )
1568  via->SetState( BUSY, false );
1569 
1570  if( segm == NULL )
1571  {
1572  switch( NbEnds )
1573  {
1574  case 0:
1575  int BeginPad, EndPad;
1576  *aStartTrace = Track;
1577  NbEnds++;
1578 
1579  // Swap ox, oy with fx, fy
1580  BeginPad = Track->GetState( BEGIN_ONPAD );
1581  EndPad = Track->GetState( END_ONPAD );
1582 
1583  Track->SetState( BEGIN_ONPAD | END_ONPAD, false );
1584 
1585  if( BeginPad )
1586  Track->SetState( END_ONPAD, true );
1587 
1588  if( EndPad )
1589  Track->SetState( BEGIN_ONPAD, true );
1590 
1591  std::swap( Track->m_Start, Track->m_End );
1592  std::swap( Track->start, Track->end );
1593  break;
1594 
1595  case 1:
1596  *aEndTrace = Track;
1597  ok = 1;
1598  return ok;
1599  }
1600  }
1601  }
1602 
1603  return ok;
1604 }
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:337
#define END_ONPAD
Pcbnew: flag set for track segment ending on a pad.
Definition: base_struct.h:147
#define BUSY
Pcbnew: flag indicating that the structure has.
Definition: base_struct.h:148
#define BEGIN_ONPAD
Pcbnew: flag set for track segment starting on a pad.
Definition: base_struct.h:146
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:338
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:271
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 284 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(), PCBNEW_CONTROL::placeBoardItems(), 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().

284 { return m_Flags; }
STATUS_FLAGS m_Flags
Flag bits for editing and other uses.
Definition: base_struct.h:204
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(), TEXTE_PCB::Flip(), PCB_TARGET::Flip(), EDGE_MODULE::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(), 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(), and TRACK::ViewGetLayers().

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:647
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 407 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(), ViaSort(), and ViewGetLOD().

408 {
409  if( GetViaType() == VIA_THROUGH )
410  return LSET::AllCuMask();
411 
412  // VIA_BLIND_BURIED or VIA_MICRVIA:
413 
414  LSET layermask;
415 
416  wxASSERT( m_Layer <= m_BottomLayer );
417 
418  // PCB_LAYER_IDs are numbered from front to back, this is top to bottom.
419  for( LAYER_NUM id = m_Layer; id <= m_BottomLayer; ++id )
420  {
421  layermask.set( id );
422  }
423 
424  return layermask;
425 }
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:455
PCB_LAYER_ID m_BottomLayer
The bottom layer of the via (the top layer is in m_Layer)
Definition: class_track.h:499
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 172 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().

173  {
174  return GetLineLength( m_Start, m_End );
175  }
wxPoint m_Start
Line start point.
Definition: class_track.h:337
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:338
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 219 of file class_track.cpp.

220 {
221  return via_xpm;
222 }
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 1068 of file class_track.cpp.

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

1069 {
1070  wxString msg;
1071  BOARD* board = GetBoard();
1072 
1073  // Display basic infos
1074  GetMsgPanelInfoBase( aList );
1075 
1076  // Display full track length (in Pcbnew)
1077  if( board )
1078  {
1079  double trackLen = 0;
1080  double lenPadToDie = 0;
1081  board->MarkTrace( this, NULL, &trackLen, &lenPadToDie, false );
1082  msg = ::LengthDoubleToString( trackLen );
1083  aList.push_back( MSG_PANEL_ITEM( _( "Length" ), msg, DARKCYAN ) );
1084 
1085  if( lenPadToDie != 0 )
1086  {
1087  msg = ::LengthDoubleToString( trackLen + lenPadToDie );
1088  aList.push_back( MSG_PANEL_ITEM( _( "Full Length" ), msg, DARKCYAN ) );
1089 
1090  msg = ::LengthDoubleToString( lenPadToDie );
1091  aList.push_back( MSG_PANEL_ITEM( _( "Pad To Die Length" ), msg, DARKCYAN ) );
1092  }
1093  }
1094 
1095  NETCLASSPTR netclass = GetNetClass();
1096 
1097  if( netclass )
1098  {
1099  aList.push_back( MSG_PANEL_ITEM( _( "NC Name" ), netclass->GetName(), DARKMAGENTA ) );
1100  aList.push_back( MSG_PANEL_ITEM( _( "NC Clearance" ),
1101  ::CoordinateToString( netclass->GetClearance(), true ),
1102  DARKMAGENTA ) );
1103  aList.push_back( MSG_PANEL_ITEM( _( "NC Width" ),
1104  ::CoordinateToString( netclass->GetTrackWidth(), true ),
1105  DARKMAGENTA ) );
1106  aList.push_back( MSG_PANEL_ITEM( _( "NC Via Size" ),
1107  ::CoordinateToString( netclass->GetViaDiameter(), true ),
1108  DARKMAGENTA ) );
1109  aList.push_back( MSG_PANEL_ITEM( _( "NC Via Drill"),
1110  ::CoordinateToString( netclass->GetViaDrill(), true ),
1111  DARKMAGENTA ) );
1112  }
1113 }
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
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
TRACK * MarkTrace(TRACK *aTrace, int *aCount, double *aTraceLength, double *aInPackageLength, bool aReorder)
Function MarkTrace marks a chain of trace segments, connected to aTrace.
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
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 1229 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().

1230 {
1231  wxString msg;
1232  BOARD* board = GetBoard();
1233 
1234  switch( GetViaType() )
1235  {
1236  default:
1237  case VIA_NOT_DEFINED:
1238  msg = wxT( "???" ); // Not used yet, does not exist currently
1239  break;
1240 
1241  case VIA_MICROVIA:
1242  msg = _( "Micro Via" ); // from external layer (TOP or BOTTOM) from
1243  // the near neighbor inner layer only
1244  break;
1245 
1246  case VIA_BLIND_BURIED:
1247  msg = _( "Blind/Buried Via" ); // from inner or external to inner
1248  // or external layer (no restriction)
1249  break;
1250 
1251  case VIA_THROUGH:
1252  msg = _( "Through Via" ); // Usual via (from TOP to BOTTOM layer only )
1253  break;
1254  }
1255 
1256  aList.push_back( MSG_PANEL_ITEM( _( "Type" ), msg, DARKCYAN ) );
1257 
1258  GetMsgPanelInfoBase_Common( aList );
1259 
1260 
1261  // Display layer pair
1262  PCB_LAYER_ID top_layer, bottom_layer;
1263 
1264  LayerPair( &top_layer, &bottom_layer );
1265 
1266  if( board )
1267  msg = board->GetLayerName( top_layer ) + wxT( "/" )
1268  + board->GetLayerName( bottom_layer );
1269  else
1270  msg.Printf( wxT( "%d/%d" ), top_layer, bottom_layer );
1271 
1272  aList.push_back( MSG_PANEL_ITEM( _( "Layers" ), msg, BROWN ) );
1273 
1274  // Display width
1275  msg = ::CoordinateToString( (unsigned) m_Width );
1276 
1277  // Display diameter value:
1278  aList.push_back( MSG_PANEL_ITEM( _( "Diameter" ), msg, DARKCYAN ) );
1279 
1280  // Display drill value
1281  int drill_value = GetDrillValue();
1282 
1283  msg = ::CoordinateToString( drill_value );
1284 
1285  wxString title = _( "Drill" );
1286  title += wxT( " " );
1287 
1288  bool drl_specific = true;
1289 
1290  if( GetBoard() )
1291  {
1292  NETINFO_ITEM* net = GetNet();
1293  int drill_class_value = 0;
1294 
1295  if( net )
1296  {
1297  if( GetViaType() == VIA_MICROVIA )
1298  drill_class_value = net->GetMicroViaDrillSize();
1299  else
1300  drill_class_value = net->GetViaDrillSize();
1301  }
1302 
1303  drl_specific = drill_value != drill_class_value;
1304  }
1305 
1306 
1307  if( drl_specific )
1308  title += _( "(Specific)" );
1309  else
1310  title += _( "(NetClass)" );
1311 
1312  aList.push_back( MSG_PANEL_ITEM( title, msg, RED ) );
1313 }
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:336
PCB_LAYER_ID
A quick note on layer IDs:
VIATYPE_T GetViaType() const
Definition: class_track.h:455
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 1115 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().

1116 {
1117  wxString msg;
1118 
1119  // Display Net Name
1120  if( GetBoard() )
1121  {
1122  NETINFO_ITEM* net = GetNet();
1123 
1124  if( net )
1125  msg = net->GetNetname();
1126  else
1127  msg = wxT( "<noname>" );
1128 
1129  aList.push_back( MSG_PANEL_ITEM( _( "NetName" ), msg, RED ) );
1130 
1131  // Display net code : (useful in test or debug)
1132  msg.Printf( wxT( "%d" ), GetNetCode() );
1133  aList.push_back( MSG_PANEL_ITEM( _( "NetCode" ), msg, RED ) );
1134  }
1135 
1136 #if defined(DEBUG)
1137 
1138  // Display the flags
1139  msg.Printf( wxT( "0x%08X" ), m_Flags );
1140  aList.push_back( MSG_PANEL_ITEM( wxT( "Flags" ), msg, BLUE ) );
1141 
1142 #if 0
1143  // Display start and end pointers:
1144  msg.Printf( wxT( "%p" ), start );
1145  aList.push_back( MSG_PANEL_ITEM( wxT( "start ptr" ), msg, BLUE ) );
1146  msg.Printf( wxT( "%p" ), end );
1147  aList.push_back( MSG_PANEL_ITEM( wxT( "end ptr" ), msg, BLUE ) );
1148  // Display this ptr
1149  msg.Printf( wxT( "%p" ), this );
1150  aList.push_back( MSG_PANEL_ITEM( wxT( "this" ), msg, BLUE ) );
1151 #endif
1152 
1153 #if 0
1154  // Display start and end positions:
1155  msg.Printf( wxT( "%d %d" ), m_Start.x, m_Start.y );
1156  aList.push_back( MSG_PANEL_ITEM( wxT( "Start pos" ), msg, BLUE ) );
1157  msg.Printf( wxT( "%d %d" ), m_End.x, m_End.y );
1158  aList.push_back( MSG_PANEL_ITEM( wxT( "End pos" ), msg, BLUE ) );
1159 #endif
1160 
1161 #endif // defined(DEBUG)
1162 
1163  // Display the State member
1164  msg = wxT( ". . " );
1165 
1166  if( GetState( TRACK_LOCKED ) )
1167  msg[0] = 'L';
1168 
1169  if( GetState( TRACK_AR ) )
1170  msg[2] = 'A';
1171 
1172  aList.push_back( MSG_PANEL_ITEM( _( "Status" ), msg, MAGENTA ) );
1173 }
Definition: colors.h:57
wxPoint m_Start
Line start point.
Definition: class_track.h:337
Definition: colors.h:61
int GetState(int type) const
Definition: base_struct.h:266
wxPoint m_End
Line end point.
Definition: class_track.h:338
#define TRACK_LOCKED
Pcbnew: track locked: protected from global deletion.
Definition: base_struct.h:142
Definition: colors.h:60
#define TRACK_AR
Pcbnew: autorouted track.
Definition: base_struct.h:143
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:204
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:227
NETCLASSPTR GetDefault() const
Function GetDefault.
BOARD_DESIGN_SETTINGS & GetDesignSettings() const
Function GetDesignSettings.
Definition: class_board.h:532
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::Autoroute(), 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(), PCB_EDIT_FRAME::Delete_Track(), DRC::doEdgeZoneDrc(), DRC::doPadToPadsDrc(), DRC::doTrackDrc(), KIGFX::PCB_PAINTER::draw(), Draw(), BOARD::DrawHighLight(), TRACK::DrawShortNetname(), 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(), 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(), BOARD_NETLIST_UPDATER::testConnectivity(), 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.
const wxString& BOARD_CONNECTED_ITEM::GetNetname ( ) const
inlineinherited
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(), 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(), 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(), 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:197
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 172 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().

173 {
174  wxString text;
175  wxString format;
176  BOARD* board = GetBoard();
177 
178  switch( GetViaType() )
179  {
180  case VIA_BLIND_BURIED:
181  format = _( "Blind/Buried Via %s, net[%s] (%d) on layers %s/%s" );
182  break;
183  case VIA_MICROVIA:
184  format = _( "Micro Via %s, Net [%s] (%d) on layers %s/%s" );
185  break;
186  // else say nothing about normal (through) vias
187  default:
188  format = _( "Via %s net [%s] (%d) on layers %s/%s" );
189  break;
190  }
191 
192 
193  if( board )
194  {
195  wxString netname = GetNetname();
196 
197  // say which layers, only two for now
198  PCB_LAYER_ID topLayer;
199  PCB_LAYER_ID botLayer;
200  LayerPair( &topLayer, &botLayer );
201  text.Printf( format.GetData(), GetChars( ShowWidth() ),
202  GetChars( netname ), GetNetCode(),
203  GetChars( board->GetLayerName( topLayer ) ),
204  GetChars( board->GetLayerName( botLayer ) ) );
205 
206  }
207  else
208  {
209  wxFAIL_MSG( wxT( "VIA::GetSelectMenuText: BOARD is NULL" ) );
210  text.Printf( format.GetData(), GetChars( ShowWidth() ),
211  wxT( "???" ), 0,
212  wxT( "??" ), wxT( "??" ) );
213  }
214 
215  return text;
216 }
PCB_LAYER_ID
A quick note on layer IDs:
VIATYPE_T GetViaType() const
Definition: class_track.h:455
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_TRACK_LIST::Add(), CN_VIA_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(), 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(), BOARD::GetVisibleTrack(), 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:337
TRACK * TRACK::GetStartNetCode ( int  NetCode)
inherited

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

516 {
517  TRACK* Track = this;
518  int ii = 0;
519 
520  if( NetCode == -1 )
521  NetCode = GetNetCode();
522 
523  while( Track != NULL )
524  {
525  if( Track->GetNetCode() > NetCode )
526  break;
527 
528  if( Track->GetNetCode() == NetCode )
529  {
530  ii++;
531  break;
532  }
533 
534  Track = (TRACK*) Track->Pnext;
535  }
536 
537  if( ii )
538  return Track;
539  else
540  return NULL;
541 }
int GetNetCode() const
Function GetNetCode.
EDA_ITEM * Pnext
next in linked list
Definition: base_struct.h:193
STATUS_FLAGS EDA_ITEM::GetStatus ( ) const
inlineinherited

Definition at line 279 of file base_struct.h.

References EDA_ITEM::m_Status.

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

279 { return m_Status; }
STATUS_FLAGS m_Status
Definition: base_struct.h:190
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 1396 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().

1398 {
1399  const wxPoint& position = GetEndPoint( aEndPoint );
1400  LSET refLayers = GetLayerSet();
1401  TRACK* previousSegment;
1402  TRACK* nextSegment;
1403 
1404  if( aSequential )
1405  {
1406  // Simple sequential search: from aStartTrace forward to aEndTrace
1407  previousSegment = NULL;
1408  nextSegment = aStartTrace;
1409  }
1410  else
1411  {
1412  /* Local bidirectional search: from this backward to aStartTrace
1413  * AND forward to aEndTrace. The idea is that nearest segments
1414  * are found (on average) faster in this way. In fact same-net
1415  * segments are almost guaranteed to be found faster, in a global
1416  * search, since they are grouped together in the track list */
1417  previousSegment = this;
1418  nextSegment = this;
1419  }
1420 
1421  while( nextSegment || previousSegment )
1422  {
1423  // Terminate the search in the direction if the netcode mis-matches
1424  if( aSameNetOnly )
1425  {
1426  if( nextSegment && (nextSegment->GetNetCode() != GetNetCode()) )
1427  nextSegment = NULL;
1428  if( previousSegment && (previousSegment->GetNetCode() != GetNetCode()) )
1429  previousSegment = NULL;
1430  }
1431 
1432  if( nextSegment )
1433  {
1434  if ( (nextSegment != this) &&
1435  !nextSegment->GetState( BUSY | IS_DELETED ) &&
1436  ( refLayers & nextSegment->GetLayerSet() ).any() )
1437  {
1438  if( (position == nextSegment->m_Start) ||
1439  (position == nextSegment->m_End) )
1440  return nextSegment;
1441  }
1442 
1443  // Keep looking forward
1444  if( nextSegment == aEndTrace )
1445  nextSegment = NULL;
1446  else
1447  nextSegment = nextSegment->Next();
1448  }
1449 
1450  // Same as above, looking back. During sequential search this branch is inactive
1451  if( previousSegment )
1452  {
1453  if( (previousSegment != this) &&
1454  !previousSegment->GetState( BUSY | IS_DELETED ) &&
1455  ( refLayers & previousSegment->GetLayerSet() ).any()
1456  )
1457  {
1458  if( (position == previousSegment->m_Start) ||
1459  (position == previousSegment->m_End) )
1460  return previousSegment;
1461  }
1462 
1463  if( previousSegment == aStartTrace )
1464  previousSegment = NULL;
1465  else
1466  previousSegment = previousSegment->Back();
1467  }
1468  }
1469 
1470  return NULL;
1471 }
wxPoint m_Start
Line start point.
Definition: class_track.h:337
#define BUSY
Pcbnew: flag indicating that the structure has.
Definition: base_struct.h:148
int GetState(int type) const
Definition: base_struct.h:266
TRACK * Back() const
Definition: class_track.h:100
Class LSET is a set of PCB_LAYER_IDs.
#define IS_DELETED
Definition: base_struct.h:130
wxPoint m_End
Line end point.
Definition: class_track.h:338
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 1365 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().

1366 {
1367  for( VIA* via = GetFirstVia( this ); via; via = GetFirstVia( via->Next() ) )
1368  {
1369  if( via->HitTest( aPosition ) &&
1370  !via->GetState( BUSY | IS_DELETED ) &&
1371  ((aLayer == UNDEFINED_LAYER) || (via->IsOnLayer( aLayer ))) )
1372  return via;
1373  }
1374 
1375  return NULL;
1376 }
#define BUSY
Pcbnew: flag indicating that the structure has.
Definition: base_struct.h:148
#define IS_DELETED
Definition: base_struct.h:130
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:508
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 1379 of file class_track.cpp.

References BUSY, GetFirstVia(), and IS_DELETED.

1380 {
1381  for( VIA* via = GetFirstVia( this, aEndTrace ); via; via = GetFirstVia( via->Next() ) )
1382  {
1383  if( via->HitTest( aPosition ) &&
1384  !via->GetState( BUSY | IS_DELETED ) &&
1385  ( aLayerMask & via->GetLayerSet() ).any()
1386  )
1387  {
1388  return via;
1389  }
1390  }
1391 
1392  return NULL;
1393 }
#define BUSY
Pcbnew: flag indicating that the structure has.
Definition: base_struct.h:148
#define IS_DELETED
Definition: base_struct.h:130
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:508
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 1321 of file class_track.cpp.

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

1322 {
1323  int max_dist = m_Width / 2;
1324 
1325  // rel_pos is aPosition relative to m_Start (or the center of the via)
1326  wxPoint rel_pos = aPosition - m_Start;
1327  double dist = (double) rel_pos.x * rel_pos.x + (double) rel_pos.y * rel_pos.y;
1328  return dist <= (double) max_dist * max_dist;
1329 }
wxPoint m_Start
Line start point.
Definition: class_track.h:337
static const int dist[10][10]
Definition: dist.cpp:57
int m_Width
Thickness of track, or via diameter.
Definition: class_track.h:336
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 1345 of file class_track.cpp.

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

1346 {
1347  EDA_RECT box;
1348  EDA_RECT arect = aRect;
1349  arect.Inflate( aAccuracy );
1350 
1351  box.SetOrigin( GetStart() );
1352  box.Inflate( GetWidth() / 2 );
1353 
1354  if( aContained )
1355  {
1356  return arect.Contains( box );
1357  }
1358  else
1359  {
1360  return arect.IntersectsCircle( GetStart(), GetWidth() / 2 );
1361  }
1362 }
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 253 of file base_struct.h.

References BRIGHTENED.

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

253 { return m_Flags & BRIGHTENED; }
#define BRIGHTENED
item is drawn with a bright contour
Definition: base_struct.h:151
STATUS_FLAGS m_Flags
Flag bits for editing and other uses.
Definition: base_struct.h:204
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 490 of file class_track.h.

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

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

Definition at line 252 of file base_struct.h.

References HIGHLIGHTED.

252 { return m_Flags & HIGHLIGHTED; }
#define HIGHLIGHTED
item is drawn in normal colors, when the rest is darkened
Definition: base_struct.h:150
STATUS_FLAGS m_Flags
Flag bits for editing and other uses.
Definition: base_struct.h:204
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:266
#define TRACK_LOCKED
Pcbnew: track locked: protected from global deletion.
Definition: base_struct.h:142
bool EDA_ITEM::IsModified ( ) const
inlineinherited

Definition at line 246 of file base_struct.h.

References IS_CHANGED.

Referenced by LIB_EDIT_FRAME::OnEditPin().

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

Definition at line 245 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(), LIB_EDIT_FRAME::OnLeftDClick(), SCH_EDIT_FRAME::OnLeftDClick(), PCB_EDIT_FRAME::OnLeftDClick(), LIB_EDIT_FRAME::OnRightClick(), SCH_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().

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

Function IsNull returns true if segment length is zero.

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

249 {
250  if( ( Type() != PCB_VIA_T ) && ( m_Start == m_End ) )
251  return true;
252  else
253  return false;
254 }
KICAD_T Type() const
Function Type()
Definition: base_struct.h:227
wxPoint m_Start
Line start point.
Definition: class_track.h:337
wxPoint m_End
Line end point.
Definition: class_track.h:338
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 392 of file class_track.cpp.

References LayerPair().

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

393 {
394  PCB_LAYER_ID bottom_layer, top_layer;
395 
396  LayerPair( &top_layer, &bottom_layer );
397 
398  wxASSERT( top_layer <= bottom_layer );
399 
400  if( top_layer <= layer_number && layer_number <= bottom_layer )
401  return true;
402  else
403  return false;
404 }
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 257 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().

258 {
259  STATUS_FLAGS result = 0;
260 
261  if( min_dist < 0 )
262  min_dist = m_Width / 2;
263 
264  if( min_dist == 0 )
265  {
266  if( m_Start == point )
267  result |= STARTPOINT;
268 
269  if( m_End == point )
270  result |= ENDPOINT;
271  }
272  else
273  {
274  double dist = GetLineLength( m_Start, point );
275 
276  if( min_dist >= KiROUND( dist ) )
277  result |= STARTPOINT;
278 
279  dist = GetLineLength( m_End, point );
280 
281  if( min_dist >= KiROUND( dist ) )
282  result |= ENDPOINT;
283  }
284 
285  return result;
286 }
wxPoint m_Start
Line start point.
Definition: class_track.h:337
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)
KiROUND rounds a floating point number to an int using "round halfway cases away from zero"...
Definition: common.h:107
static const int dist[10][10]
Definition: dist.cpp:57
int m_Width
Thickness of track, or via diameter.
Definition: class_track.h:336
wxPoint m_End
Line end point.
Definition: class_track.h:338
unsigned STATUS_FLAGS
Definition: base_struct.h:160
#define ENDPOINT
Definition: base_struct.h:133
#define STARTPOINT
Definition: base_struct.h:132
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 473 of file base_struct.h.

References EDA_ITEM::operator<().

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

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

Definition at line 251 of file base_struct.h.

References IS_RESIZED.

Referenced by ExitSheet().

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

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

250 { return m_Flags & SELECTED; }
#define SELECTED
Definition: base_struct.h:134
STATUS_FLAGS m_Flags
Flag bits for editing and other uses.
Definition: base_struct.h:204
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:227
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 249 of file base_struct.h.

References IS_WIRE_IMAGE.

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

249 { return m_Flags & IS_WIRE_IMAGE; }
#define IS_WIRE_IMAGE
Item to be drawn as wireframe while editing.
Definition: base_struct.h:131
STATUS_FLAGS m_Flags
Flag bits for editing and other uses.
Definition: base_struct.h:204
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 132 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(), EDA_ITEM::HitTest(), GERBER_FILE_IMAGE::Visit(), MODULE::Visit(), and BOARD::Visit().

136 {
137  EDA_ITEM* p = listStart;
138 
139  for( ; p; p = p->Pnext )
140  {
141  if( SEARCH_QUIT == p->Visit( inspector, testData, scanTypes ) )
142  return SEARCH_QUIT;
143  }
144 
145  return SEARCH_CONTINUE;
146 }
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:180
EDA_ITEM * Pnext
next in linked list
Definition: base_struct.h:193
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 449 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(), SELECTION_TOOL::selectable(), PCB_EDIT_FRAME::Swap_Layers(), and PNS_KICAD_IFACE::syncVia().

450 {
451  PCB_LAYER_ID t_layer = F_Cu;
452  PCB_LAYER_ID b_layer = B_Cu;
453 
454  if( GetViaType() != VIA_THROUGH )
455  {
456  b_layer = m_BottomLayer;
457  t_layer = m_Layer;
458 
459  if( b_layer < t_layer )
460  std::swap( b_layer, t_layer );
461  }
462 
463  if( top_layer )
464  *top_layer = t_layer;
465 
466  if( bottom_layer )
467  *bottom_layer = b_layer;
468 }
PCB_LAYER_ID m_Layer
PCB_LAYER_ID
A quick note on layer IDs:
VIATYPE_T GetViaType() const
Definition: class_track.h:455
PCB_LAYER_ID m_BottomLayer
The bottom layer of the via (the top layer is in m_Layer)
Definition: class_track.h:499
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 429 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().

430  {
431  return false;
432  }
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 184 of file base_struct.cpp.

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

185 {
186  wxString text = aText;
187  wxString searchText = aSearchData.GetFindString();
188 
189  // Don't match if searching for replaceable item and the item doesn't support text replace.
190  if( (aSearchData.GetFlags() & FR_SEARCH_REPLACE) && !IsReplaceable() )
191  return false;
192 
193  if( aSearchData.GetFlags() & wxFR_WHOLEWORD )
194  return aText.IsSameAs( searchText, aSearchData.GetFlags() & wxFR_MATCHCASE );
195 
196  if( aSearchData.GetFlags() & FR_MATCH_WILDCARD )
197  {
198  if( aSearchData.GetFlags() & wxFR_MATCHCASE )
199  return text.Matches( searchText );
200 
201  return text.MakeUpper().Matches( searchText.MakeUpper() );
202  }
203 
204  if( aSearchData.GetFlags() & wxFR_MATCHCASE )
205  return aText.Find( searchText ) != wxNOT_FOUND;
206 
207  return text.MakeUpper().Find( searchText.MakeUpper() ) != wxNOT_FOUND;
208 }
virtual bool IsReplaceable() const
Function IsReplaceable.
Definition: base_struct.h:473
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:337
wxPoint m_End
Line end point.
Definition: class_track.h:338
void BOARD_ITEM::Move ( const VECTOR2I aMoveVector)
inlineinherited

Definition at line 239 of file class_board_item.h.

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

240  {
241  Move( wxPoint( aMoveVector.x, aMoveVector.y ) );
242  }
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(), PCB_EDIT_FRAME::Block_SelectItems(), 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::End_Route(), 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(), PCB_EDIT_FRAME::Swap_Layers(), 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:193
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 241 of file base_struct.cpp.

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

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

242 {
243  wxFAIL_MSG( wxString::Format( wxT( "Less than operator not defined for item type %s." ),
244  GetChars( GetClass() ) ) );
245 
246  return false;
247 }
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 211 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().

212 {
213  wxCHECK_MSG( IsReplaceable(), false,
214  wxT( "Attempt to replace text in <" ) + GetClass() + wxT( "> item." ) );
215 
216  wxString searchString = (aSearchData.GetFlags() & wxFR_MATCHCASE) ? aText : aText.Upper();
217 
218  int result = searchString.Find( (aSearchData.GetFlags() & wxFR_MATCHCASE) ?
219  aSearchData.GetFindString() :
220  aSearchData.GetFindString().Upper() );
221 
222  if( result == wxNOT_FOUND )
223  return false;
224 
225  wxString prefix = aText.Left( result );
226  wxString suffix;
227 
228  if( aSearchData.GetFindString().length() + result < aText.length() )
229  suffix = aText.Right( aText.length() - ( aSearchData.GetFindString().length() + result ) );
230 
231  wxLogTrace( traceFindReplace, wxT( "Replacing '%s', prefix '%s', replace '%s', suffix '%s'." ),
232  GetChars( aText ), GetChars( prefix ), GetChars( aSearchData.GetReplaceString() ),
233  GetChars( suffix ) );
234 
235  aText = prefix + aSearchData.GetReplaceString() + suffix;
236 
237  return true;
238 }
virtual bool IsReplaceable() const
Function IsReplaceable.
Definition: base_struct.h:473
const wxString traceFindReplace
Flag to enable find and replace debug tracing.
Definition: base_struct.cpp:58
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 461 of file base_struct.h.

461 { 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 342 of file class_track.cpp.

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

Referenced by TRACK::Move().

343 {
344  RotatePoint( &m_Start, aRotCentre, aAngle );
345  RotatePoint( &m_End, aRotCentre, aAngle );
346 }
wxPoint m_Start
Line start point.
Definition: class_track.h:337
void RotatePoint(int *pX, int *pY, double angle)
Definition: trigo.cpp:317
wxPoint m_End
Line end point.
Definition: class_track.h:338
void BOARD_ITEM::Rotate ( const VECTOR2I aRotCentre,
double  aAngle 
)
inlineinherited

Definition at line 255 of file class_board_item.h.

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

256  {
257  Rotate( wxPoint( aRotCentre.x, aRotCentre.y ), aAngle );
258  }
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 483 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().

484 {
485  if( GetViaType() == VIA_THROUGH )
486  {
487  m_Layer = F_Cu;
489  }
490 
491  if( m_BottomLayer < m_Layer )
492  std::swap( m_BottomLayer, m_Layer );
493 }
PCB_LAYER_ID m_Layer
VIATYPE_T GetViaType() const
Definition: class_track.h:455
PCB_LAYER_ID m_BottomLayer
The bottom layer of the via (the top layer is in m_Layer)
Definition: class_track.h:499
void VIA::SetBottomLayer ( PCB_LAYER_ID  aLayer)

Definition at line 443 of file class_track.cpp.

References m_BottomLayer.

Referenced by DIALOG_TRACK_VIA_PROPERTIES::Apply().

444 {
445  m_BottomLayer = aLayer;
446 }
PCB_LAYER_ID m_BottomLayer
The bottom layer of the via (the top layer is in m_Layer)
Definition: class_track.h:499
void EDA_ITEM::SetBrightened ( )
inlineinherited

Definition at line 258 of file base_struct.h.

References BRIGHTENED, and EDA_ITEM::SetFlags().

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

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

Function SetDrill sets the drill value for vias.

Parameters
aDrillis the new drill diameter

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

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

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

Definition at line 484 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:503
#define UNDEFINED_DRILL_DIAMETER
Definition: class_track.h:59
void EDA_ITEM::SetFlags ( STATUS_FLAGS  aMask)
inlineinherited

Definition at line 282 of file base_struct.h.

Referenced by SCH_EAGLE_PLUGIN::addBusEntries(), SCH_SCREEN::addConnectedItemsToBlock(), 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(), PCB_BASE_FRAME::LoadModuleFromLibrary(), 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().

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

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

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

Definition at line 257 of file base_struct.h.

References HIGHLIGHTED, and EDA_ITEM::SetFlags().

257 { SetFlags( HIGHLIGHTED ); }
void SetFlags(STATUS_FLAGS aMask)
Definition: base_struct.h:282
#define HIGHLIGHTED
item is drawn in normal colors, when the rest is darkened
Definition: base_struct.h:150
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(), TEXTE_PCB::Flip(), PCB_TARGET::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 428 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().

429 {
430 
431  m_Layer = aTopLayer;
432  m_BottomLayer = aBottomLayer;
433  SanitizeLayers();
434 }
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:499
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 243 of file base_struct.h.

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

243 { m_List = aList; }
DHEAD * m_List
which DLIST I am on.
Definition: base_struct.h:195
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:142
void SetState(int type, int state)
Definition: base_struct.h:271
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 242 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(), FOOTPRINT_EDIT_FRAME::restoreLastFootprint(), 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().

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

Reimplemented from TRACK.

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

428 { m_Start = aPoint; m_End = aPoint; }
wxPoint m_Start
Line start point.
Definition: class_track.h:337
wxPoint m_End
Line end point.
Definition: class_track.h:338
void EDA_ITEM::SetSelected ( )
inlineinherited

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

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

Definition at line 232 of file base_struct.h.

Referenced by 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(), PCB_BASE_FRAME::LoadModuleFromLibrary(), LEGACY_PLUGIN::loadPCB_TARGET(), LEGACY_PLUGIN::loadPCB_TEXT(), EAGLE_PLUGIN::loadPlain(), 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(), and TestDuplicateSheetNames().

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

Definition at line 437 of file class_track.cpp.

References BOARD_ITEM::m_Layer.

Referenced by DIALOG_TRACK_VIA_PROPERTIES::Apply().

438 {
439  m_Layer = aLayer;
440 }
PCB_LAYER_ID m_Layer
void EDA_ITEM::SetWireImage ( )
inlineinherited

Definition at line 255 of file base_struct.h.

References IS_WIRE_IMAGE, and EDA_ITEM::SetFlags().

Referenced by moveItemWithMouseCursor().

255 { SetFlags( IS_WIRE_IMAGE ); }
void SetFlags(STATUS_FLAGS aMask)
Definition: base_struct.h:282
#define IS_WIRE_IMAGE
Item to be drawn as wireframe while editing.
Definition: base_struct.h:131
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 110 of file class_track.cpp.

References CoordinateToString(), and TRACK::m_Width.

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

111 {
112  wxString msg = ::CoordinateToString( m_Width );
113  return msg;
114 }
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:336
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 492 of file base_struct.h.

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

Referenced by PART_LIB::GetEntryTypePowerNames().

492 { 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 1652 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().

1653 {
1654  assert( aImage->Type() == PCB_VIA_T );
1655 
1656  std::swap( *((VIA*) this), *((VIA*) aImage) );
1657 }
KICAD_T Type() const
Function Type()
Definition: base_struct.h:227
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 471 of file class_track.cpp.

References BOARD_ITEM::m_Layer.

Referenced by DIALOG_TRACK_VIA_PROPERTIES::DIALOG_TRACK_VIA_PROPERTIES().

472 {
473  return m_Layer;
474 }
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 595 of file board_items_to_polygon_shape_transform.cpp.

References KiROUND(), PCB_VIA_T, TransformCircleToPolygon(), TransformOvalClearanceToPolygon(), and EDA_ITEM::Type().

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

599 {
600  switch( Type() )
601  {
602  case PCB_VIA_T:
603  {
604  int radius = (m_Width / 2) + aClearanceValue;
605  radius = KiROUND( radius * aCorrectionFactor );
606  TransformCircleToPolygon( aCornerBuffer, m_Start, radius, aCircleToSegmentsCount );
607  }
608  break;
609 
610  default:
612  m_Width + ( 2 * aClearanceValue),
613  aCircleToSegmentsCount,
614  aCorrectionFactor );
615  break;
616  }
617 }
KICAD_T Type() const
Function Type()
Definition: base_struct.h:227
wxPoint m_Start
Line start point.
Definition: class_track.h:337
static int KiROUND(double v)
KiROUND rounds a floating point number to an int using "round halfway cases away from zero"...
Definition: common.h:107
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:336
wxPoint m_End
Line end point.
Definition: class_track.h:338
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 227 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(), PCB_EDIT_FRAME::Attribut_Track(), PCB_EDIT_FRAME::Autoroute(), 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(), TEXTE_PCB::ClassOf(), EDGE_MODULE::ClassOf(), BOARD_CONNECTED_ITEM::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(), 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(), 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(), 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(), 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(), LIB_EDIT_FRAME::OnLeftClick(), SCH_EDIT_FRAME::OnLeftClick(), PCB_EDIT_FRAME::OnLeftClick(), LIB_EDIT_FRAME::OnLeftDClick(), SCH_EDIT_FRAME::OnLeftDClick(), PCB_EDIT_FRAME::OnLeftDClick(), SCH_EDIT_FRAME::OnMoveItem(), SCH_EDIT_FRAME::OnOpenLibraryEditor(), SCH_EDIT_FRAME::OnOrient(), FOOTPRINT_EDIT_FRAME::OnRightClick(), LIB_EDIT_FRAME::OnRightClick(), SCH_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(), GERBVIEW_SELECTION_TOOL::RequestSelection(), SELECTION_TOOL::RequestSelection(), 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(), CN_CONNECTIVITY_ALGO::searchConnections(), 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(), TRACK::TransformShapeWithClearanceToPolygon(), 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().

228  {
229  return m_StructType;
230  }
KICAD_T m_StructType
Run time identification, keep private so it can never be changed after a constructor sets it...
Definition: base_struct.h:189
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:238
const BOX2I EDA_ITEM::ViewBBox ( ) const
overridevirtualinherited

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

Returns
BOX2I - the current bounding box

Implements KIGFX::VIEW_ITEM.

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

Definition at line 267 of file base_struct.cpp.

References EDA_ITEM::GetBoundingBox().

Referenced by SELECTION_TOOL::selectable(), SELECTION_TOOL::selectMultiple(), EDA_ITEM::Sort(), BRIGHT_BOX::ViewBBox(), DIMENSION::ViewBBox(), DRAWSEGMENT::ViewBBox(), BRIGHT_BOX::ViewDraw(), and COMMON_TOOLS::ZoomFitScreen().

268 {
269  // Basic fallback
270  return BOX2I( VECTOR2I( GetBoundingBox().GetOrigin() ),
271  VECTOR2I( GetBoundingBox().GetSize() ) );
272 }
virtual const EDA_RECT GetBoundingBox() const
Function GetBoundingBox returns the orthogonal, bounding box of this object for display purposes...
BOX2< VECTOR2I > BOX2I
Definition: box2.h:468
VECTOR2< int > VECTOR2I
Definition: vector2d.h:589
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 115 of file view_item.h.

References KIGFX::VIEW_ITEM::ViewGetLayers().

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

116  {}
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 1023 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.

1024 {
1025  aLayers[0] = LAYER_VIAS_HOLES;
1026  aLayers[1] = LAYER_VIAS_NETNAMES;
1027  aCount = 3;
1028 
1029  // Just show it on common via & via holes layers
1030  switch( GetViaType() )
1031  {
1032  case VIA_THROUGH:
1033  aLayers[2] = LAYER_VIA_THROUGH;
1034  break;
1035 
1036  case VIA_BLIND_BURIED:
1037  aLayers[2] = LAYER_VIA_BBLIND;
1038  aLayers[3] = m_Layer;
1039  aLayers[4] = m_BottomLayer;
1040  aCount += 2;
1041  break;
1042 
1043  case VIA_MICROVIA:
1044  aLayers[2] = LAYER_VIA_MICROVIA;
1045  break;
1046 
1047  default:
1048  aLayers[2] = LAYER_GP_OVERLAY;
1049  wxASSERT( false );
1050  break;
1051  }
1052 }
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:455
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:499
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 1055 of file class_track.cpp.

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

1056 {
1057  BOARD* board = GetBoard();
1058 
1059  // Only draw the via if at least one of the layers it crosses is being displayed
1060  if( board && ( board->GetVisibleLayers() & GetLayerSet() ).any() )
1061  return 0;
1062 
1064 }
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 377 of file class_track.cpp.

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

Referenced by TRACK::GetLength().

378 {
379  KICAD_T stype = *scanTypes;
380 
381  // If caller wants to inspect my type
382  if( stype == Type() )
383  {
384  if( SEARCH_QUIT == inspector( this, testData ) )
385  return SEARCH_QUIT;
386  }
387 
388  return SEARCH_CONTINUE;
389 }
KICAD_T Type() const
Function Type()
Definition: base_struct.h:227
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 499 of file class_track.h.

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

int VIA::m_Drill
private

Definition at line 503 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 204 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 201 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 195 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 501 of file class_track.h.

EDA_ITEM* EDA_ITEM::Pback
protectedinherited

previous in linked list

Definition at line 194 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: