KiCad PCB EDA Suite
DIMENSION Class Reference

Class DIMENSION. More...

#include <class_dimension.h>

Inheritance diagram for DIMENSION:
BOARD_ITEM EDA_ITEM KIGFX::VIEW_ITEM

Public Member Functions

 DIMENSION (BOARD_ITEM *aParent)
 
 ~DIMENSION ()
 
void SetValue (int aValue)
 
int GetValue () const
 
const wxPoint GetPosition () const override
 
void SetPosition (const wxPoint &aPos) override
 
void SetTextSize (const wxSize &aTextSize)
 
void SetLayer (PCB_LAYER_ID aLayer) override
 Function SetLayer sets the layer this item is on. More...
 
void SetShape (int aShape)
 
int GetShape () const
 
int GetWidth () const
 
void SetWidth (int aWidth)
 
void SetOrigin (const wxPoint &aOrigin)
 Function SetOrigin Sets a new origin of the crossbar line. More...
 
const wxPoint & GetOrigin () const
 Function GetOrigin. More...
 
void SetEnd (const wxPoint &aEnd)
 Function SetEnd Sets a new end of the crossbar line. More...
 
const wxPoint & GetEnd ()
 Function GetEnd. More...
 
void SetHeight (int aHeight)
 Function SetHeight Sets the length of feature lines. More...
 
int GetHeight () const
 Function GetHeight Returns the length of feature lines. More...
 
void UpdateHeight ()
 Function UpdateHeight Updates stored height basing on points coordinates. More...
 
double GetAngle () const
 Function GetAngle Returns angle of the crossbar. More...
 
void AdjustDimensionDetails ()
 Function AdjustDimensionDetails Calculate coordinates of segments used to draw the dimension. More...
 
void GetUnits (EDA_UNITS_T &aUnits, bool &aUseMils) const
 
void SetUnits (EDA_UNITS_T aUnits, bool aUseMils)
 
void SetText (const wxString &NewText)
 
const wxString GetText () const
 
TEXTE_PCBText ()
 
TEXTE_PCBText () const
 
void Print (PCB_BASE_FRAME *aFrame, wxDC *DC, const wxPoint &offset=ZeroOffset) override
 Function Print BOARD_ITEMs have their own color information. More...
 
void Move (const wxPoint &offset) override
 Function Move. More...
 
void Rotate (const wxPoint &aRotCentre, double aAngle) override
 Function Rotate Rotate this object. More...
 
void Flip (const wxPoint &aCentre, bool aFlipLeftRight) override
 Function Flip Flip this object, i.e. More...
 
void Mirror (const wxPoint &axis_pos, bool aMirrorLeftRight=false)
 Function Mirror Mirror the Dimension , relative to a given horizontal axis the text is not mirrored. More...
 
void GetMsgPanelInfo (EDA_UNITS_T aUnits, 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...
 
bool HitTest (const wxPoint &aPosition, int aAccuracy) const override
 Function HitTest tests if aPosition is contained within or on the bounding box of an item. More...
 
bool HitTest (const EDA_RECT &aRect, bool aContained, int aAccuracy=0) const override
 Function HitTest tests if aRect intersects or is contained within the bounding box of an item. More...
 
wxString GetClass () const override
 Function GetClass returns the class name. More...
 
const EDA_RECT GetBoundingBox () const override
 Function GetBoundingBox returns the orthogonal, bounding box of this object for display purposes. More...
 
wxString GetSelectMenuText (EDA_UNITS_T aUnits) const override
 Function GetSelectMenuText returns the text to display to be used in the selection clarification context menu when multiple items are found at the current cursor position. More...
 
BITMAP_DEF GetMenuImage () const override
 Function GetMenuImage returns a pointer to an image to be used in menus. More...
 
EDA_ITEMClone () const override
 Function Clone creates a duplicate of this item with linked list members set to NULL. More...
 
virtual const BOX2I ViewBBox () const override
 Function ViewBBox() returns the bounding box of the item covering all its layers. More...
 
virtual void SwapData (BOARD_ITEM *aImage) override
 Swap data between aItem and aImage. More...
 
virtual const wxPoint GetCenter () const
 Function GetCenter() More...
 
virtual bool IsConnected () const
 Function IsConnected() Returns information if the object is derived from BOARD_CONNECTED_ITEM. More...
 
BOARD_ITEM_CONTAINERGetParent () const
 
virtual PCB_LAYER_ID GetLayer () const
 Function GetLayer returns the primary layer this item is on. More...
 
virtual LSET GetLayerSet () const
 Function GetLayerSet returns a "layer mask", which is a bitmap of all layers on which the TRACK segment or VIA physically resides. More...
 
virtual bool IsOnLayer (PCB_LAYER_ID aLayer) const
 Function IsOnLayer tests to see if this object is on the given layer. More...
 
bool IsTrack () const
 Function IsTrack tests to see if this object is a track or via (or microvia). More...
 
virtual bool IsLocked () const
 Function IsLocked. More...
 
virtual void SetLocked (bool aLocked)
 Function SetLocked modifies 'lock' status for of the item. More...
 
virtual void UnLink ()
 Function UnLink detaches this object from its owner. More...
 
void DeleteStructure ()
 Function DeleteStructure deletes this object after UnLink()ing it from its owner if it has one. More...
 
void Move (const VECTOR2I &aMoveVector)
 
void Rotate (const VECTOR2I &aRotCentre, double aAngle)
 
void Flip (const VECTOR2I &aCentre, bool aFlipLeftRight)
 
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...
 
virtual void ViewGetLayers (int aLayers[], int &aCount) const override
 Function ViewGetLayers() Returns the all the layers within the VIEW the object is painted on. More...
 
virtual void TransformShapeWithClearanceToPolygon (SHAPE_POLY_SET &aCornerBuffer, int aClearanceValue, int aError=ARC_LOW_DEF, bool ignoreLineWidth=false) const
 Function TransformShapeWithClearanceToPolygon Convert the item shape to a closed polygon Used in filling zones calculations Circles and arcs are approximated by segments. More...
 
KICAD_T Type () const
 Function Type() More...
 
void SetTimeStamp (timestamp_t aNewTimeStamp)
 
timestamp_t GetTimeStamp () const
 
EDA_ITEMNext () const
 
EDA_ITEMBack () const
 
DHEADGetList () const
 
void SetNext (EDA_ITEM *aNext)
 
void SetBack (EDA_ITEM *aBack)
 
void SetParent (EDA_ITEM *aParent)
 
void SetList (DHEAD *aList)
 
bool IsNew () const
 
bool IsModified () const
 
bool IsMoving () const
 
bool IsDragging () const
 
bool IsWireImage () const
 
bool IsSelected () const
 
bool IsResized () const
 
bool IsHighlighted () const
 
bool IsBrightened () const
 
void SetWireImage ()
 
void SetSelected ()
 
void SetHighlighted ()
 
void SetBrightened ()
 
void ClearSelected ()
 
void ClearHighlighted ()
 
void ClearBrightened ()
 
void SetModified ()
 
int GetState (int type) const
 
void SetState (int type, int state)
 
STATUS_FLAGS GetStatus () const
 
void SetStatus (STATUS_FLAGS aStatus)
 
void SetFlags (STATUS_FLAGS aMask)
 
void ClearFlags (STATUS_FLAGS aMask=EDA_ITEM_ALL_FLAGS)
 
STATUS_FLAGS GetFlags () const
 
STATUS_FLAGS GetEditFlags () const
 
void ClearTempFlags ()
 
void ClearEditFlags ()
 
virtual bool IsType (const KICAD_T aScanTypes[])
 Function IsType Checks whether the item is one of the listed types. More...
 
void SetForceVisible (bool aEnable)
 Function SetForceVisible is used to set and cleag force visible flag used to force the item to be drawn even if it's draw attribute is set to not visible. More...
 
virtual SEARCH_RESULT Visit (INSPECTOR inspector, void *testData, const KICAD_T scanTypes[])
 Function Visit may be re-implemented for each derived class in order to handle all the types given by its member data. More...
 
virtual bool Matches (wxFindReplaceData &aSearchData, void *aAuxData)
 Function Matches compares the item against the search criteria in aSearchData. More...
 
bool Replace (wxFindReplaceData &aSearchData, wxString &aText)
 Helper function used in search and replace dialog Function Replace performs a text replace on aText using the find and replace criteria in aSearchData on items that support text find and replace. More...
 
virtual bool Replace (wxFindReplaceData &aSearchData, void *aAuxData=NULL)
 Function Replace performs a text replace using the find and replace criteria in aSearchData on items that support text find and replace. More...
 
virtual bool IsReplaceable () const
 Function IsReplaceable. More...
 
bool operator< (const EDA_ITEM &aItem) const
 Test if another item is less than this object. More...
 
virtual void ViewDraw (int aLayer, VIEW *aView) const
 Function ViewDraw() Draws the parts of the object belonging to layer aLayer. More...
 
virtual unsigned int ViewGetLOD (int aLayer, VIEW *aView) const
 Function ViewGetLOD() Returns the level of detail (LOD) of the item. More...
 
VIEW_ITEM_DATA * viewPrivData () const
 
void ClearViewPrivData ()
 

Static Public Member Functions

static bool ClassOf (const EDA_ITEM *aItem)
 
static wxString ShowShape (STROKE_T aShape)
 Function ShowShape converts the enum STROKE_T integer value to a wxString. More...
 
static SEARCH_RESULT IterateForward (EDA_ITEM *listStart, INSPECTOR inspector, void *testData, const KICAD_T scanTypes[])
 Function IterateForward walks through the object tree calling the inspector() on each object type requested in scanTypes. More...
 
template<class T >
static SEARCH_RESULT IterateForward (std::deque< T > &aList, INSPECTOR inspector, void *testData, const KICAD_T scanTypes[])
 IterateForward( EDA_ITEM*, INSPECTOR, void*, const KICAD_T ) 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

wxPoint m_crossBarO
 
wxPoint m_crossBarF
 
wxPoint m_featureLineGO
 
wxPoint m_featureLineGF
 
wxPoint m_featureLineDO
 
wxPoint m_featureLineDF
 
wxPoint m_arrowD1F
 
wxPoint m_arrowD2F
 
wxPoint m_arrowG1F
 
wxPoint m_arrowG2F
 

Static Public Attributes

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

Protected Member Functions

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

Static Protected Member Functions

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

Protected Attributes

PCB_LAYER_ID m_Layer
 
EDA_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

int m_Width
 Line width. More...
 
int m_Shape
 Currently always 0. More...
 
EDA_UNITS_T m_Unit
 0 = inches, 1 = mm More...
 
bool m_UseMils
 If inches, use mils. More...
 
int m_Value
 value of PCB dimensions. More...
 
int m_Height
 length of feature lines More...
 
TEXTE_PCB m_Text
 

Detailed Description

Class DIMENSION.

For better understanding of the points that make a dimension:

       m_featureLineGO  m_featureLineDO
       |                              |
       |                              |
       |                              |
       |  m_arrowG2F      m_arrowD2F  |
       | /                          \ |

m_crossBarO|/____________________________|m_crossBarF |\ m_Text /| | \ / | | m_arrowG1F m_arrowD1F | | | m_featureLineGF m_featureLineDF

Definition at line 61 of file class_dimension.h.

Constructor & Destructor Documentation

◆ DIMENSION()

DIMENSION::DIMENSION ( BOARD_ITEM aParent)

Definition at line 42 of file class_dimension.cpp.

42  :
43  BOARD_ITEM( aParent, PCB_DIMENSION_T ),
44  m_Width( Millimeter2iu( 0.2 ) ),
45  m_Unit( INCHES ),
46  m_UseMils( false ),
47  m_Value( 0 ),
48  m_Height( 0 ),
49  m_Text( this )
50 {
52  m_Shape = 0;
53 }
int m_Height
length of feature lines
TEXTE_PCB m_Text
int m_Shape
Currently always 0.
PCB_LAYER_ID m_Layer
EDA_UNITS_T m_Unit
0 = inches, 1 = mm
bool m_UseMils
If inches, use mils.
Definition: common.h:158
class DIMENSION, a dimension (graphic item)
Definition: typeinfo.h:98
BOARD_ITEM(BOARD_ITEM *aParent, KICAD_T idtype)
int m_Width
Line width.
int m_Value
value of PCB dimensions.

References Dwgs_User, BOARD_ITEM::m_Layer, and m_Shape.

Referenced by Clone().

◆ ~DIMENSION()

DIMENSION::~DIMENSION ( )

Definition at line 56 of file class_dimension.cpp.

57 {
58 }

Member Function Documentation

◆ AdjustDimensionDetails()

void DIMENSION::AdjustDimensionDetails ( )

Function AdjustDimensionDetails Calculate coordinates of segments used to draw the dimension.

Definition at line 230 of file class_dimension.cpp.

231 {
232  const int arrowz = Mils2iu( 50 ); // size of arrows
233  int ii;
234  int measure, deltax, deltay; // value of the measure on X and Y axes
235  int arrow_up_X = 0, arrow_up_Y = 0; // coordinates of arrow line /
236  int arrow_dw_X = 0, arrow_dw_Y = 0; // coordinates of arrow line '\'
237  int hx, hy; // dimension line interval
238  double angle, angle_f;
239 
240  // Init layer :
241  m_Text.SetLayer( GetLayer() );
242 
243  // calculate the size of the dimension (text + line above the text)
245 
246  deltax = m_featureLineDO.x - m_featureLineGO.x;
247  deltay = m_featureLineDO.y - m_featureLineGO.y;
248 
249  // Calculate dimension value
250  measure = KiROUND( hypot( deltax, deltay ) );
251 
252  angle = atan2( (double)deltay, (double)deltax );
253 
254  // Calculation of parameters X and Y dimensions of the arrows and lines.
255  hx = hy = ii;
256 
257  // Taking into account the slope of the side lines.
258  if( measure )
259  {
260  hx = abs( KiROUND( ( (double) deltay * hx ) / measure ) );
261  hy = abs( KiROUND( ( (double) deltax * hy ) / measure ) );
262 
263  if( m_featureLineGO.x > m_crossBarO.x )
264  hx = -hx;
265 
266  if( m_featureLineGO.x == m_crossBarO.x )
267  hx = 0;
268 
269  if( m_featureLineGO.y > m_crossBarO.y )
270  hy = -hy;
271 
272  if( m_featureLineGO.y == m_crossBarO.y )
273  hy = 0;
274 
275  angle_f = angle + DEG2RAD( 27.5 );
276  arrow_up_X = wxRound( arrowz * cos( angle_f ) );
277  arrow_up_Y = wxRound( arrowz * sin( angle_f ) );
278  angle_f = angle - DEG2RAD( 27.5 );
279  arrow_dw_X = wxRound( arrowz * cos( angle_f ) );
280  arrow_dw_Y = wxRound( arrowz * sin( angle_f ) );
281  }
282 
283  int dx = KiROUND( m_Height * cos( angle + M_PI / 2 ) );
284  int dy = KiROUND( m_Height * sin( angle + M_PI / 2 ) );
285  m_crossBarO.x = m_featureLineGO.x + dx;
286  m_crossBarO.y = m_featureLineGO.y + dy;
287  m_crossBarF.x = m_featureLineDO.x + dx;
288  m_crossBarF.y = m_featureLineDO.y + dy;
289 
290  m_arrowG1F.x = m_crossBarO.x + arrow_up_X;
291  m_arrowG1F.y = m_crossBarO.y + arrow_up_Y;
292 
293  m_arrowG2F.x = m_crossBarO.x + arrow_dw_X;
294  m_arrowG2F.y = m_crossBarO.y + arrow_dw_Y;
295 
296  /* The right arrow is symmetrical to the left.
297  * / = -\ and \ = -/
298  */
299  m_arrowD1F.x = m_crossBarF.x - arrow_dw_X;
300  m_arrowD1F.y = m_crossBarF.y - arrow_dw_Y;
301 
302  m_arrowD2F.x = m_crossBarF.x - arrow_up_X;
303  m_arrowD2F.y = m_crossBarF.y - arrow_up_Y;
304 
305  // Length of feature lines
306  double radius = ( m_Height +
307  ( std::copysign( 1.0, m_Height ) *
308  arrowz * sin( DEG2RAD( 27.5 ) ) ) );
309 
310  m_featureLineGF.x = m_featureLineGO.x - wxRound( radius * sin( angle ) );
311  m_featureLineGF.y = m_featureLineGO.y + wxRound( radius * cos( angle ) );
312 
313  m_featureLineDF.x = m_featureLineDO.x - wxRound( radius * sin( angle ) );
314  m_featureLineDF.y = m_featureLineDO.y + wxRound( radius * cos( angle ) );
315 
316  // Calculate the better text position and orientation:
317  radius = ( std::copysign( 1.0, m_Height ) * ii );
318 
319  wxPoint textPos;
320  textPos.x = ( m_crossBarF.x + m_crossBarO.x ) / 2;
321  textPos.y = ( m_crossBarF.y + m_crossBarO.y ) / 2;
322 
323  textPos.x -= KiROUND( radius * sin( angle ) );
324  textPos.y += KiROUND( radius * cos( angle ) );
325 
326  m_Text.SetTextPos( textPos );
327 
328  double newAngle = -RAD2DECIDEG( angle );
329 
330  NORMALIZE_ANGLE_POS( newAngle );
331 
332  if( newAngle > 900 && newAngle < 2700 )
333  newAngle -= 1800;
334 
335  m_Text.SetTextAngle( newAngle );
336 
337  m_Value = measure;
339 }
void SetTextAngle(double aAngle)
void SetText(const wxString &NewText)
static int KiROUND(double v)
Round a floating point number to an integer using "round halfway cases away from zero".
Definition: common.h:118
virtual void SetLayer(PCB_LAYER_ID aLayer)
Function SetLayer sets the layer this item is on.
wxPoint m_crossBarF
int m_Height
length of feature lines
wxPoint m_arrowD1F
void SetTextPos(const wxPoint &aPoint)
Definition: eda_text.h:217
double RAD2DECIDEG(double rad)
Definition: trigo.h:215
TEXTE_PCB m_Text
int GetThickness() const
Function GetThickness returns pen width.
Definition: eda_text.h:148
wxPoint m_featureLineDF
void NORMALIZE_ANGLE_POS(T &Angle)
Definition: trigo.h:252
#define abs(a)
Definition: auxiliary.h:84
int GetTextHeight() const
Definition: eda_text.h:215
wxPoint m_featureLineGO
wxString MessageTextFromValue(EDA_UNITS_T aUnits, int aValue, bool aUseMils)
Definition: base_units.cpp:125
EDA_UNITS_T m_Unit
0 = inches, 1 = mm
bool m_UseMils
If inches, use mils.
wxPoint m_arrowG1F
wxPoint m_arrowD2F
wxPoint m_arrowG2F
int m_Width
Line width.
double DEG2RAD(double deg)
Definition: trigo.h:210
static DIRECTION_45::AngleType angle(const VECTOR2I &a, const VECTOR2I &b)
wxPoint m_crossBarO
wxPoint m_featureLineDO
virtual PCB_LAYER_ID GetLayer() const
Function GetLayer returns the primary layer this item is on.
int m_Value
value of PCB dimensions.
wxPoint m_featureLineGF

References abs, PNS::angle(), DEG2RAD(), BOARD_ITEM::GetLayer(), EDA_TEXT::GetTextHeight(), EDA_TEXT::GetThickness(), KiROUND(), m_arrowD1F, m_arrowD2F, m_arrowG1F, m_arrowG2F, m_crossBarF, m_crossBarO, m_featureLineDF, m_featureLineDO, m_featureLineGF, m_featureLineGO, m_Height, m_Text, m_Unit, m_UseMils, m_Value, m_Width, MessageTextFromValue(), NORMALIZE_ANGLE_POS(), RAD2DECIDEG(), BOARD_ITEM::SetLayer(), SetText(), TEXTE_PCB::SetTextAngle(), and EDA_TEXT::SetTextPos().

Referenced by EAGLE_PLUGIN::loadPlain(), SetEnd(), SetHeight(), and SetOrigin().

◆ Back()

EDA_ITEM* EDA_ITEM::Back ( ) const
inlineinherited

Definition at line 206 of file base_struct.h.

206 { return Pback; }
EDA_ITEM * Pback
previous in linked list
Definition: base_struct.h:164

References EDA_ITEM::Pback.

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

◆ ClassOf()

static bool DIMENSION::ClassOf ( const EDA_ITEM aItem)
inlinestatic

Definition at line 86 of file class_dimension.h.

87  {
88  return aItem && PCB_DIMENSION_T == aItem->Type();
89  }
class DIMENSION, a dimension (graphic item)
Definition: typeinfo.h:98
KICAD_T Type() const
Function Type()
Definition: base_struct.h:197

References PCB_DIMENSION_T, and EDA_ITEM::Type().

◆ ClearBrightened()

void EDA_ITEM::ClearBrightened ( )
inlineinherited

Definition at line 232 of file base_struct.h.

232 { ClearFlags( BRIGHTENED ); }
#define BRIGHTENED
item is drawn with a bright contour
Definition: base_struct.h:130
void ClearFlags(STATUS_FLAGS aMask=EDA_ITEM_ALL_FLAGS)
Definition: base_struct.h:253

References BRIGHTENED, and EDA_ITEM::ClearFlags().

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

◆ ClearEditFlags()

void EDA_ITEM::ClearEditFlags ( )
inlineinherited

◆ ClearFlags()

void EDA_ITEM::ClearFlags ( STATUS_FLAGS  aMask = EDA_ITEM_ALL_FLAGS)
inlineinherited

Definition at line 253 of file base_struct.h.

253 { m_Flags &= ~aMask; }
STATUS_FLAGS m_Flags
Flag bits for editing and other uses.
Definition: base_struct.h:174

References EDA_ITEM::m_Flags.

Referenced by FOOTPRINT_VIEWER_FRAME::AddFootprintToPCB(), PNS_KICAD_IFACE::AddItem(), SCH_COMPONENT::ClearAllHighlightFlags(), SCH_SCREEN::ClearAnnotation(), EDA_ITEM::ClearBrightened(), EDA_ITEM::ClearEditFlags(), EDA_ITEM::ClearHighlighted(), clearModuleItemFlags(), EDA_ITEM::ClearSelected(), EDA_ITEM::ClearTempFlags(), SCH_EDIT_FRAME::ConvertPart(), LIB_EDIT_TOOL::Copy(), MWAVE::CreateMicrowaveInductor(), DIALOG_LIB_EDIT_PIN::DIALOG_LIB_EDIT_PIN(), DIALOG_PAD_PROPERTIES::DIALOG_PAD_PROPERTIES(), KIGFX::SCH_PAINTER::draw(), LIB_EDIT_TOOL::Duplicate(), SCH_ITEM::Duplicate(), PCB_EDIT_FRAME::Exchange_Module(), LIB_EDIT_FRAME::GetComponentFromRedoList(), LIB_EDIT_FRAME::GetComponentFromUndoList(), KIGFX::SCH_VIEW::HighlightItem(), MODULE_EDITOR_TOOLS::ImportFootprint(), FOOTPRINT_EDIT_FRAME::Load_Module_From_BOARD(), FOOTPRINT_EDIT_FRAME::LoadModuleFromLibrary(), EDIT_POINTS_FACTORY::Make(), FOOTPRINT_EDIT_FRAME::OpenProjectFiles(), PCB_BASE_FRAME::PlaceModule(), LIB_PIN_TOOL::PlacePin(), DRAWING_TOOL::PlaceText(), FOOTPRINT_EDIT_FRAME::Process_Special_Functions(), BOARD_COMMIT::Push(), SCH_EDIT_TOOL::RepeatDrawItem(), LIB_PIN_TOOL::RepeatPin(), LIB_EDIT_FRAME::RollbackPartFromUndo(), SCH_EDIT_FRAME::SaveCopyForRepeatItem(), FOOTPRINT_EDIT_FRAME::SaveFootprintToBoard(), SCH_LEGACY_PLUGIN_CACHE::savePin(), EE_SELECTION_TOOL::SelectPoint(), SCH_EDIT_FRAME::SelectUnit(), DIALOG_EDIT_COMPONENT_IN_SCHEMATIC::TransferDataFromWindow(), DIALOG_PAD_PROPERTIES::TransferDataFromWindow(), and SCH_DRAWING_TOOLS::TwoClickPlace().

◆ ClearHighlighted()

void EDA_ITEM::ClearHighlighted ( )
inlineinherited

Definition at line 231 of file base_struct.h.

231 { ClearFlags( HIGHLIGHTED ); }
#define HIGHLIGHTED
item is drawn in normal colors, when the rest is darkened
Definition: base_struct.h:129
void ClearFlags(STATUS_FLAGS aMask=EDA_ITEM_ALL_FLAGS)
Definition: base_struct.h:253

References EDA_ITEM::ClearFlags(), and HIGHLIGHTED.

◆ ClearSelected()

void EDA_ITEM::ClearSelected ( )
inlineinherited

◆ ClearTempFlags()

void EDA_ITEM::ClearTempFlags ( )
inlineinherited

Definition at line 264 of file base_struct.h.

265  {
267  }
#define IS_LINKED
Used in calculation to mark linked items (temporary use)
Definition: base_struct.h:104
#define SKIP_STRUCT
flag indicating that the structure should be ignored
Definition: base_struct.h:118
#define CANDIDATE
flag indicating that the structure is connected
Definition: base_struct.h:117
#define ENDPOINT
ends. (Used to support dragging.)
Definition: base_struct.h:113
void ClearFlags(STATUS_FLAGS aMask=EDA_ITEM_ALL_FLAGS)
Definition: base_struct.h:253
#define DO_NOT_DRAW
Used to disable draw function.
Definition: base_struct.h:119
#define STARTPOINT
When a line is selected, these flags indicate which.
Definition: base_struct.h:112

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

Referenced by SCH_EDIT_FRAME::PutDataInPreviousState().

◆ ClearViewPrivData()

void KIGFX::VIEW_ITEM::ClearViewPrivData ( )
inlineinherited

Definition at line 153 of file view_item.h.

154  {
155  m_viewPrivData = NULL;
156  }
VIEW_ITEM_DATA * m_viewPrivData
Definition: view_item.h:161

References KIGFX::VIEW_ITEM::m_viewPrivData.

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

◆ Clone()

EDA_ITEM * DIMENSION::Clone ( ) const
overridevirtual

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

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

Returns
A clone of the item.

Reimplemented from EDA_ITEM.

Definition at line 508 of file class_dimension.cpp.

509 {
510  return new DIMENSION( *this );
511 }
DIMENSION(BOARD_ITEM *aParent)

References DIMENSION().

◆ DeleteStructure()

void BOARD_ITEM::DeleteStructure ( )
inherited

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

Definition at line 127 of file class_board_item.cpp.

128 {
129  auto parent = GetParent();
130 
131  if( parent )
132  parent->Remove( this );
133 
134  delete this;
135 }
BOARD_ITEM_CONTAINER * GetParent() const

References BOARD_ITEM::GetParent().

Referenced by BOARD::PadDelete(), DIALOG_FOOTPRINT_FP_EDITOR::TransferDataFromWindow(), and DIALOG_FOOTPRINT_BOARD_EDITOR::TransferDataFromWindow().

◆ Flip() [1/2]

void DIMENSION::Flip ( const wxPoint &  aCentre,
bool  aFlipLeftRight 
)
overridevirtual

Function Flip Flip this object, i.e.

change the board side for this object

Parameters
aCentre- the rotation point.
aFlipLeftRight- mirror across Y axis instead of X (the default)

Reimplemented from BOARD_ITEM.

Definition at line 138 of file class_dimension.cpp.

139 {
140  Mirror( aCentre );
141 
142  // DIMENSION items are not usually on copper layers, so
143  // copper layers count is not taken in accoun in Flip transform
144  SetLayer( FlipLayer( GetLayer() ) );
145 }
PCB_LAYER_ID FlipLayer(PCB_LAYER_ID aLayerId, int aCopperLayersCount)
Function FlippedLayerNumber.
Definition: lset.cpp:475
void Mirror(const wxPoint &axis_pos, bool aMirrorLeftRight=false)
Function Mirror Mirror the Dimension , relative to a given horizontal axis the text is not mirrored.
void SetLayer(PCB_LAYER_ID aLayer) override
Function SetLayer sets the layer this item is on.
virtual PCB_LAYER_ID GetLayer() const
Function GetLayer returns the primary layer this item is on.

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

◆ Flip() [2/2]

void BOARD_ITEM::Flip ( const VECTOR2I aCentre,
bool  aFlipLeftRight 
)
inlineinherited

Definition at line 270 of file class_board_item.h.

271  {
272  Flip( wxPoint( aCentre.x, aCentre.y ), aFlipLeftRight );
273  }
virtual void Flip(const wxPoint &aCentre, bool aFlipLeftRight)
Function Flip Flip this object, i.e.

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

◆ GetAngle()

double DIMENSION::GetAngle ( ) const
inline

Function GetAngle Returns angle of the crossbar.

Returns
Angle of the crossbar line expressed in radians.

Definition at line 171 of file class_dimension.h.

172  {
173  wxPoint delta( m_featureLineDO - m_featureLineGO );
174 
175  return atan2( (double)delta.y, (double)delta.x );
176  }
wxPoint m_featureLineGO
wxPoint m_featureLineDO

References m_featureLineDO, and m_featureLineGO.

◆ GetBoard()

BOARD * BOARD_ITEM::GetBoard ( ) const
virtualinherited

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

Definition at line 64 of file class_board_item.cpp.

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 }
Definition: typeinfo.h:85
Class BOARD_ITEM is a base class for any item which can be embedded within the BOARD container class,...
virtual BOARD * GetBoard() const
Function GetBoard returns the BOARD in which this BOARD_ITEM resides, or NULL if none.
Class BOARD holds information pertinent to a Pcbnew printed circuit board.
Definition: class_board.h:161
BOARD_ITEM_CONTAINER * GetParent() const
KICAD_T Type() const
Function Type()
Definition: base_struct.h:197

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

Referenced by ZONE_CONTAINER::BuildSmoothedPoly(), DRC::checkClearancePadToPad(), DRC::checkClearanceSegmToPad(), TEXTE_PCB::Flip(), TRACK::Flip(), VIA::Flip(), ZONE_CONTAINER::Flip(), BOARD_ITEM::GetBoard(), MODULE::GetBoundingPoly(), BOARD_CONNECTED_ITEM::GetClearance(), BOARD_ITEM::GetLayerName(), PCB_DRAW_PANEL_GAL::GetMsgPanelInfo(), TRACK::GetMsgPanelInfo(), NETINFO_ITEM::GetMsgPanelInfo(), D_PAD::GetMsgPanelInfo(), TRACK::GetMsgPanelInfoBase(), VIA::GetMsgPanelInfoBase(), TRACK::GetMsgPanelInfoBase_Common(), BOARD_CONNECTED_ITEM::GetNetClass(), BOARD_CONNECTED_ITEM::GetNetnameMsg(), VIA::GetSelectMenuText(), D_PAD::GetSelectMenuText(), D_PAD::GetSolderMaskMargin(), D_PAD::GetSolderPasteMargin(), BOARD::GetTrackLength(), D_PAD::HitTest(), D_PAD::MergePrimitivesAsPolygon(), EAGLE_PLUGIN::packageWire(), TEXTE_PCB::Print(), PCB_TARGET::Print(), ZONE_CONTAINER::Print(), EDGE_MODULE::Print(), TRACK::Print(), TEXTE_MODULE::Print(), Print(), DRAWSEGMENT::Print(), VIA::Print(), MODULE::Print(), D_PAD::Print(), ZONE_CONTAINER::PrintFilledArea(), BOARD_CONNECTED_ITEM::SetNet(), BOARD_CONNECTED_ITEM::SetNetCode(), ZONE_CONTAINER::TransformOutlinesShapeWithClearanceToPolygon(), ZONE_CONTAINER::TransformSolidAreasShapesToPolygonSet(), MODULE::ViewBBox(), VIA::ViewGetLOD(), and D_PAD::ViewGetLOD().

◆ GetBoundingBox()

const EDA_RECT DIMENSION::GetBoundingBox ( ) const
overridevirtual

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

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

Reimplemented from EDA_ITEM.

Definition at line 437 of file class_dimension.cpp.

438 {
439  EDA_RECT bBox;
440  int xmin, xmax, ymin, ymax;
441 
442  bBox = m_Text.GetTextBox( -1 );
443  xmin = bBox.GetX();
444  xmax = bBox.GetRight();
445  ymin = bBox.GetY();
446  ymax = bBox.GetBottom();
447 
448  xmin = std::min( xmin, m_crossBarO.x );
449  xmin = std::min( xmin, m_crossBarF.x );
450  ymin = std::min( ymin, m_crossBarO.y );
451  ymin = std::min( ymin, m_crossBarF.y );
452  xmax = std::max( xmax, m_crossBarO.x );
453  xmax = std::max( xmax, m_crossBarF.x );
454  ymax = std::max( ymax, m_crossBarO.y );
455  ymax = std::max( ymax, m_crossBarF.y );
456 
457  xmin = std::min( xmin, m_featureLineGO.x );
458  xmin = std::min( xmin, m_featureLineGF.x );
459  ymin = std::min( ymin, m_featureLineGO.y );
460  ymin = std::min( ymin, m_featureLineGF.y );
461  xmax = std::max( xmax, m_featureLineGO.x );
462  xmax = std::max( xmax, m_featureLineGF.x );
463  ymax = std::max( ymax, m_featureLineGO.y );
464  ymax = std::max( ymax, m_featureLineGF.y );
465 
466  xmin = std::min( xmin, m_featureLineDO.x );
467  xmin = std::min( xmin, m_featureLineDF.x );
468  ymin = std::min( ymin, m_featureLineDO.y );
469  ymin = std::min( ymin, m_featureLineDF.y );
470  xmax = std::max( xmax, m_featureLineDO.x );
471  xmax = std::max( xmax, m_featureLineDF.x );
472  ymax = std::max( ymax, m_featureLineDO.y );
473  ymax = std::max( ymax, m_featureLineDF.y );
474 
475  bBox.SetX( xmin );
476  bBox.SetY( ymin );
477  bBox.SetWidth( xmax - xmin + 1 );
478  bBox.SetHeight( ymax - ymin + 1 );
479 
480  bBox.Normalize();
481 
482  return bBox;
483 }
wxPoint m_crossBarF
int GetX() const
Definition: eda_rect.h:109
TEXTE_PCB m_Text
wxPoint m_featureLineDF
int GetBottom() const
Definition: eda_rect.h:122
wxPoint m_featureLineGO
EDA_RECT GetTextBox(int aLine=-1, int aThickness=-1, bool aInvertY=false) const
Function GetTextBox useful in multiline texts to calculate the full text or a line area (for zones fi...
Definition: eda_text.cpp:167
void SetHeight(int val)
Definition: eda_rect.h:133
int GetRight() const
Definition: eda_rect.h:119
void SetX(int val)
Definition: eda_rect.h:130
void SetWidth(int val)
Definition: eda_rect.h:132
void SetY(int val)
Definition: eda_rect.h:131
void Normalize()
Function Normalize ensures that the height ant width are positive.
#define max(a, b)
Definition: auxiliary.h:86
Class EDA_RECT handles the component boundary box.
Definition: eda_rect.h:44
int GetY() const
Definition: eda_rect.h:110
wxPoint m_crossBarO
wxPoint m_featureLineDO
#define min(a, b)
Definition: auxiliary.h:85
wxPoint m_featureLineGF

References EDA_RECT::GetBottom(), EDA_RECT::GetRight(), EDA_TEXT::GetTextBox(), EDA_RECT::GetX(), EDA_RECT::GetY(), m_crossBarF, m_crossBarO, m_featureLineDF, m_featureLineDO, m_featureLineGF, m_featureLineGO, m_Text, max, min, EDA_RECT::Normalize(), EDA_RECT::SetHeight(), EDA_RECT::SetWidth(), EDA_RECT::SetX(), and EDA_RECT::SetY().

Referenced by HitTest(), and ViewBBox().

◆ GetCenter()

virtual const wxPoint BOARD_ITEM::GetCenter ( ) const
inlinevirtualinherited

Function GetCenter()

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

Returns
centre point of the item

Reimplemented in DRAWSEGMENT.

Definition at line 98 of file class_board_item.h.

98 { return GetPosition(); }
virtual const wxPoint GetPosition() const =0

References BOARD_ITEM::GetPosition().

◆ GetClass()

wxString DIMENSION::GetClass ( ) const
inlineoverridevirtual

Function GetClass returns the class name.

Returns
wxString

Implements EDA_ITEM.

Definition at line 226 of file class_dimension.h.

227  {
228  return wxT( "DIMENSION" );
229  }

◆ GetEditFlags()

STATUS_FLAGS EDA_ITEM::GetEditFlags ( ) const
inlineinherited

Definition at line 256 of file base_struct.h.

257  {
261  return m_Flags & mask;
262  }
#define END_ONPAD
Pcbnew: flag set for track segment ending on a pad.
Definition: base_struct.h:126
#define BEGIN_ONPAD
Pcbnew: flag set for track segment starting on a pad.
Definition: base_struct.h:125
#define EDA_ITEM_ALL_FLAGS
Definition: base_struct.h:141
#define SELECTED
Definition: base_struct.h:114
#define BRIGHTENED
item is drawn with a bright contour
Definition: base_struct.h:130
#define DP_COUPLED
item is coupled with another item making a differential pair
Definition: base_struct.h:132
#define HIGHLIGHTED
item is drawn in normal colors, when the rest is darkened
Definition: base_struct.h:129
#define IS_DANGLING
indicates a pin is dangling
Definition: base_struct.h:136
STATUS_FLAGS m_Flags
Flag bits for editing and other uses.
Definition: base_struct.h:174
#define ENDPOINT
ends. (Used to support dragging.)
Definition: base_struct.h:113
#define STARTPOINT
When a line is selected, these flags indicate which.
Definition: base_struct.h:112

References BEGIN_ONPAD, BRIGHTENED, DP_COUPLED, EDA_ITEM_ALL_FLAGS, END_ONPAD, ENDPOINT, HIGHLIGHTED, IS_DANGLING, EDA_ITEM::m_Flags, SELECTED, and STARTPOINT.

Referenced by SCH_EDIT_TOOL::ChangeShape(), EDA_ITEM::ClearEditFlags(), SCH_EDIT_FRAME::ConvertTextType(), SCH_EDIT_FRAME::DeleteJunction(), PCB_EDIT_FRAME::Edit_TrackSegm_Width(), SCH_EDIT_TOOL::editComponentFieldText(), SCH_EDITOR_CONTROL::EditWithLibEdit(), LIB_MOVE_TOOL::Main(), POINT_EDITOR::OnSelectionChange(), BOARD::Print(), LIB_EDIT_TOOL::Properties(), SCH_EDIT_TOOL::Properties(), SCH_EDIT_FRAME::SchematicCleanUp(), SCH_EDIT_FRAME::SelectUnit(), DIALOG_TARGET_PROPERTIES::TransferDataFromWindow(), DIALOG_LIB_EDIT_PIN::TransferDataFromWindow(), DIALOG_TEXT_PROPERTIES::TransferDataFromWindow(), DIALOG_EDIT_COMPONENT_IN_SCHEMATIC::TransferDataFromWindow(), DIALOG_LABEL_EDITOR::TransferDataFromWindow(), and DIALOG_FOOTPRINT_BOARD_EDITOR::TransferDataFromWindow().

◆ GetEnd()

const wxPoint& DIMENSION::GetEnd ( )
inline

Function GetEnd.

Returns
End of the crossbar line.

Definition at line 139 of file class_dimension.h.

140  {
141  return m_featureLineDO;
142  }
wxPoint m_featureLineDO

References m_featureLineDO.

Referenced by DRAWING_TOOL::constrainDimension(), and POINT_EDITOR::updateItem().

◆ GetFlags()

◆ GetHeight()

int DIMENSION::GetHeight ( ) const
inline

Function GetHeight Returns the length of feature lines.

Definition at line 155 of file class_dimension.h.

156  {
157  return m_Height;
158  }
int m_Height
length of feature lines

References m_Height.

◆ GetLayer()

virtual PCB_LAYER_ID BOARD_ITEM::GetLayer ( ) const
inlinevirtualinherited

Function GetLayer returns the primary layer this item is on.

Reimplemented in ZONE_CONTAINER.

Definition at line 123 of file class_board_item.h.

123 { return m_Layer; }
PCB_LAYER_ID m_Layer

References BOARD_ITEM::m_Layer.

Referenced by CN_CONNECTIVITY_ALGO::Add(), CN_LIST::Add(), CINFO3D_VISU::AddGraphicsShapesWithClearanceToContainer(), AdjustDimensionDetails(), AR_AUTOPLACER::buildFpAreas(), CreateBoardSection(), MWAVE::CreateMicrowaveInductor(), CreateRoutesSection(), DIALOG_GRAPHIC_ITEM_PROPERTIES::DIALOG_GRAPHIC_ITEM_PROPERTIES(), DIALOG_TEXT_PROPERTIES::DIALOG_TEXT_PROPERTIES(), DIALOG_TRACK_VIA_PROPERTIES::DIALOG_TRACK_VIA_PROPERTIES(), DRC::doTrackDrc(), KIGFX::PCB_PAINTER::draw(), PCB_EDIT_FRAME::Exchange_Module(), export_vrml_drawsegment(), export_vrml_edge_module(), export_vrml_module(), export_vrml_pcbtext(), export_vrml_text_module(), TEXTE_PCB::Flip(), PCB_TARGET::Flip(), EDGE_MODULE::Flip(), TRACK::Flip(), TEXTE_MODULE::Flip(), Flip(), DRAWSEGMENT::Flip(), MODULE::Flip(), PCB_IO::FootprintSave(), FootprintWriteShape(), PCB_IO::formatLayer(), DSN::SPECCTRA_DB::FromBOARD(), AR_AUTOPLACER::genModuleOnRoutingMatrix(), ZONE_CONTAINER::GetLayer(), AR_AUTOPLACER::getOptimalModulePlacement(), BOARD::GetPad(), TEXT_MOD_GRID_TABLE::GetValueAsLong(), SELECTION_TOOL::guessSelectionCandidates(), idf_export_module(), GENERAL_COLLECTOR::Inspect(), PCB_LAYER_COLLECTOR::Inspect(), D_PAD::IsFlipped(), EDGE_MODULE::IsParentFlipped(), TEXTE_MODULE::IsParentFlipped(), itemIsIncludedByFilter(), FOOTPRINT_EDIT_FRAME::Load_Module_From_BOARD(), DIALOG_FOOTPRINT_FP_EDITOR::OnAddField(), DIALOG_FOOTPRINT_BOARD_EDITOR::OnAddField(), EAGLE_PLUGIN::packagePad(), 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(), TEXTE_MODULE::Print(), DRAWSEGMENT::Print(), DIALOG_GLOBAL_EDIT_TEXT_AND_GRAPHICS::processItem(), processTextItem(), SELECTION_TOOL::selectable(), TEXT_MOD_GRID_TABLE::SetValueAsLong(), ShowClearance(), GLOBAL_EDIT_TOOL::swapBoardItem(), PNS_KICAD_IFACE::syncGraphicalItem(), PNS_KICAD_IFACE::syncTrack(), DRC::testCopperDrawItem(), DRC::testCopperTextAndGraphics(), DRC::testCopperTextItem(), DRC::testDisabledLayers(), AR_AUTOPLACER::testModuleOnBoard(), TEXTE_MODULE::TEXTE_MODULE(), AR_MATRIX::TraceSegmentPcb(), DIALOG_FOOTPRINT_BOARD_EDITOR::TransferDataFromWindow(), DIALOG_TEXT_PROPERTIES::TransferDataToWindow(), DIALOG_GRAPHIC_ITEM_PROPERTIES::TransferDataToWindow(), DIALOG_FOOTPRINT_BOARD_EDITOR::TransferDataToWindow(), CINFO3D_VISU::transformGraphicModuleEdgeToPolygonSet(), MODULE::TransformGraphicShapesWithClearanceToPolygonSet(), MODULE::TransformGraphicTextWithClearanceToPolygonSet(), TEXTE_MODULE::ViewGetLayers(), TRACK::ViewGetLayers(), TEXTE_MODULE::ViewGetLOD(), DIALOG_GLOBAL_EDIT_TRACKS_AND_VIAS::visitItem(), and DIALOG_GLOBAL_EDIT_TEXT_AND_GRAPHICS::visitItem().

◆ GetLayerName()

wxString BOARD_ITEM::GetLayerName ( ) const
inherited

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

Returns
wxString containing the layer name associated with this item.

Definition at line 78 of file class_board_item.cpp.

79 {
80  BOARD* board = GetBoard();
81 
82  if( board )
83  return board->GetLayerName( m_Layer );
84 
85  // If no parent, return standard name
87 }
const wxString GetLayerName(PCB_LAYER_ID aLayer) const
Function GetLayerName returns the name of a layer given by aLayer.
PCB_LAYER_ID m_Layer
virtual BOARD * GetBoard() const
Function GetBoard returns the BOARD in which this BOARD_ITEM resides, or NULL if none.
Class BOARD holds information pertinent to a Pcbnew printed circuit board.
Definition: class_board.h:161
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:659

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

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

◆ GetLayerSet()

virtual LSET BOARD_ITEM::GetLayerSet ( ) const
inlinevirtualinherited

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

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

Reimplemented in D_PAD, VIA, and ZONE_CONTAINER.

Definition at line 131 of file class_board_item.h.

131 { return LSET( m_Layer ); }
PCB_LAYER_ID m_Layer
Class LSET is a set of PCB_LAYER_IDs.

References BOARD_ITEM::m_Layer.

Referenced by GRID_HELPER::BestSnapAnchor(), build_pad_testpoints(), DRC::doTrackDrc(), DRAWING_TOOL::DrawVia(), hash_board_item(), and POINT_EDITOR::OnSelectionChange().

◆ GetList()

DHEAD* EDA_ITEM::GetList ( ) const
inlineinherited

Definition at line 208 of file base_struct.h.

208 { return m_List; }
DHEAD * m_List
which DLIST I am on.
Definition: base_struct.h:165

References EDA_ITEM::m_List.

Referenced by DHEAD::insert(), DHEAD::remove(), BOARD_ITEM::UnLink(), and GERBER_DRAW_ITEM::UnLink().

◆ GetMenuImage()

BITMAP_DEF DIMENSION::GetMenuImage ( ) const
overridevirtual

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

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

Returns
The menu image associated with the item.

Reimplemented from EDA_ITEM.

Definition at line 492 of file class_dimension.cpp.

493 {
494  return add_dimension_xpm;
495 }

◆ GetMsgPanelInfo()

void DIMENSION::GetMsgPanelInfo ( EDA_UNITS_T  aUnits,
std::vector< MSG_PANEL_ITEM > &  aList 
)
overridevirtual

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 380 of file class_dimension.cpp.

381 {
382  // for now, display only the text within the DIMENSION using class TEXTE_PCB.
383  m_Text.GetMsgPanelInfo( aUnits, aList );
384 }
TEXTE_PCB m_Text
void GetMsgPanelInfo(EDA_UNITS_T aUnits, std::vector< MSG_PANEL_ITEM > &aList) override
Function GetMsgPanelInfo populates aList of MSG_PANEL_ITEM objects with it's internal state for displ...

References TEXTE_PCB::GetMsgPanelInfo(), and m_Text.

◆ getNextNumberInSequence()

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

Definition at line 98 of file class_board_item.cpp.

99 {
100  if( aSeq.empty() )
101  return 1;
102 
103  // By default go to the end of the sequence
104  int candidate = *aSeq.rbegin();
105 
106  // Filling in gaps in pad numbering
107  if( aFillSequenceGaps )
108  {
109  // start at the beginning
110  candidate = *aSeq.begin();
111 
112  for( auto it : aSeq )
113  {
114  if( it - candidate > 1 )
115  break;
116 
117  candidate = it;
118  }
119  }
120 
121  ++candidate;
122 
123  return candidate;
124 }

Referenced by MODULE::GetNextPadName().

◆ GetOrigin()

const wxPoint& DIMENSION::GetOrigin ( ) const
inline

Function GetOrigin.

Returns
Origin of the crossbar line.

Definition at line 123 of file class_dimension.h.

124  {
125  return m_featureLineGO;
126  }
wxPoint m_featureLineGO

References m_featureLineGO.

Referenced by DRAWING_TOOL::constrainDimension(), and POINT_EDITOR::updateItem().

◆ GetParent()

BOARD_ITEM_CONTAINER* BOARD_ITEM::GetParent ( void  ) const
inlineinherited

Definition at line 117 of file class_board_item.h.

117 { return (BOARD_ITEM_CONTAINER*) m_Parent; }
EDA_ITEM * m_Parent
Linked list: Link (parent struct)
Definition: base_struct.h:167
Abstract interface for BOARD_ITEMs capable of storing other items inside.

References EDA_ITEM::m_Parent.

Referenced by POINT_EDITOR::addCorner(), ALIGN_DISTRIBUTE_TOOL::AlignBottom(), ALIGN_DISTRIBUTE_TOOL::AlignCenterX(), ALIGN_DISTRIBUTE_TOOL::AlignCenterY(), ALIGN_DISTRIBUTE_TOOL::AlignTop(), BOARD_ITEM::DeleteStructure(), ALIGN_DISTRIBUTE_TOOL::doAlignLeft(), ALIGN_DISTRIBUTE_TOOL::doAlignRight(), ALIGN_DISTRIBUTE_TOOL::doDistributeCentersHorizontally(), ALIGN_DISTRIBUTE_TOOL::doDistributeCentersVertically(), ALIGN_DISTRIBUTE_TOOL::doDistributeGapsHorizontally(), ALIGN_DISTRIBUTE_TOOL::doDistributeGapsVertically(), KIGFX::PCB_PAINTER::draw(), EditToolSelectionFilter(), 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(), ARRAY_CREATOR::Invoke(), EDGE_MODULE::IsParentFlipped(), TEXTE_MODULE::IsParentFlipped(), LEGACY_PLUGIN::loadMODULE_TEXT(), BRDITEMS_PLOTTER::Plot_1_EdgeModule(), BRDITEMS_PLOTTER::PlotTextModule(), BOARD_COMMIT::Push(), PCB_BASE_EDIT_FRAME::SaveCopyInUndoList(), SELECTION_TOOL::select(), SwapItemData(), DRC::testCopperDrawItem(), DIALOG_TEXT_PROPERTIES::TransferDataToWindow(), and DIALOG_GLOBAL_EDIT_TEXT_AND_GRAPHICS::visitItem().

◆ GetPosition()

const wxPoint DIMENSION::GetPosition ( ) const
overridevirtual

Implements BOARD_ITEM.

Definition at line 67 of file class_dimension.cpp.

68 {
69  return m_Text.GetTextPos();
70 }
TEXTE_PCB m_Text
const wxPoint & GetTextPos() const
Definition: eda_text.h:218

References EDA_TEXT::GetTextPos(), and m_Text.

Referenced by ViewBBox().

◆ GetSelectMenuText()

wxString DIMENSION::GetSelectMenuText ( EDA_UNITS_T  aUnits) const
overridevirtual

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

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

Returns
The menu text string.

Reimplemented from EDA_ITEM.

Definition at line 486 of file class_dimension.cpp.

487 {
488  return wxString::Format( _( "Dimension \"%s\" on %s" ), GetText(), GetLayerName() );
489 }
#define _(s)
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
const wxString GetText() const
wxString GetLayerName() const
Function GetLayerName returns the name of the PCB layer on which the item resides.

References _, Format(), BOARD_ITEM::GetLayerName(), and GetText().

◆ GetShape()

int DIMENSION::GetShape ( ) const
inline

Definition at line 107 of file class_dimension.h.

107 { return m_Shape; }
int m_Shape
Currently always 0.

References m_Shape.

◆ GetState()

int EDA_ITEM::GetState ( int  type) const
inlineinherited

Definition at line 236 of file base_struct.h.

237  {
238  return m_Status & type;
239  }
STATUS_FLAGS m_Status
Definition: base_struct.h:160

References EDA_ITEM::m_Status.

Referenced by SELECTION_TOOL::expandConnection(), TRACK::GetMsgPanelInfoBase_Common(), TRACK::IsLocked(), TRACK::Print(), and ZONE_CONTAINER::PrintFilledArea().

◆ GetStatus()

STATUS_FLAGS EDA_ITEM::GetStatus ( ) const
inlineinherited

Definition at line 249 of file base_struct.h.

249 { return m_Status; }
STATUS_FLAGS m_Status
Definition: base_struct.h:160

References EDA_ITEM::m_Status.

Referenced by PCB_IO::format().

◆ GetText()

const wxString DIMENSION::GetText ( ) const

Definition at line 79 of file class_dimension.cpp.

80 {
81  return m_Text.GetText();
82 }
TEXTE_PCB m_Text
virtual const wxString & GetText() const
Function GetText returns the string associated with the text object.
Definition: eda_text.h:124

References EDA_TEXT::GetText(), and m_Text.

Referenced by GetSelectMenuText().

◆ GetTimeStamp()

◆ GetUnits()

void DIMENSION::GetUnits ( EDA_UNITS_T aUnits,
bool &  aUseMils 
) const
inline

Definition at line 184 of file class_dimension.h.

185  {
186  aUnits = m_Unit;
187  aUseMils = m_UseMils;
188  }
EDA_UNITS_T m_Unit
0 = inches, 1 = mm
bool m_UseMils
If inches, use mils.

References m_Unit, and m_UseMils.

Referenced by DIALOG_TEXT_PROPERTIES::OnDimensionUnitsChange(), and DIALOG_TEXT_PROPERTIES::TransferDataToWindow().

◆ GetValue()

int DIMENSION::GetValue ( ) const
inline

Definition at line 93 of file class_dimension.h.

93 { return m_Value; }
int m_Value
value of PCB dimensions.

References m_Value.

Referenced by PCB_IO::format().

◆ GetWidth()

int DIMENSION::GetWidth ( ) const
inline

◆ HitTest() [1/2]

bool DIMENSION::HitTest ( const wxPoint &  aPosition,
int  aAccuracy 
) const
overridevirtual

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

Parameters
aPositionA reference to a wxPoint object containing the coordinates to test.
aAccuracyIncrease the item bounding box by this amount.
Returns
True if aPosition is within the item bounding box.

Reimplemented from EDA_ITEM.

Definition at line 387 of file class_dimension.cpp.

388 {
389  if( m_Text.TextHitTest( aPosition ) )
390  return true;
391 
392  int dist_max = aAccuracy + ( m_Width / 2 );
393 
394  // Locate SEGMENTS
395 
396  if( TestSegmentHit( aPosition, m_crossBarO, m_crossBarF, dist_max ) )
397  return true;
398 
399  if( TestSegmentHit( aPosition, m_featureLineGO, m_featureLineGF, dist_max ) )
400  return true;
401 
402  if( TestSegmentHit( aPosition, m_featureLineDO, m_featureLineDF, dist_max ) )
403  return true;
404 
405  if( TestSegmentHit( aPosition, m_crossBarF, m_arrowD1F, dist_max ) )
406  return true;
407 
408  if( TestSegmentHit( aPosition, m_crossBarF, m_arrowD2F, dist_max ) )
409  return true;
410 
411  if( TestSegmentHit( aPosition, m_crossBarO, m_arrowG1F, dist_max ) )
412  return true;
413 
414  if( TestSegmentHit( aPosition, m_crossBarO, m_arrowG2F, dist_max ) )
415  return true;
416 
417  return false;
418 }
wxPoint m_crossBarF
wxPoint m_arrowD1F
TEXTE_PCB m_Text
wxPoint m_featureLineDF
wxPoint m_featureLineGO
wxPoint m_arrowG1F
wxPoint m_arrowD2F
wxPoint m_arrowG2F
int m_Width
Line width.
virtual bool TextHitTest(const wxPoint &aPoint, int aAccuracy=0) const
Function TextHitTest Test if aPoint is within the bounds of this object.
Definition: eda_text.cpp:319
wxPoint m_crossBarO
bool TestSegmentHit(const wxPoint &aRefPoint, wxPoint aStart, wxPoint aEnd, int aDist)
Function TestSegmentHit test for hit on line segment i.e.
Definition: trigo.cpp:126
wxPoint m_featureLineDO
wxPoint m_featureLineGF

References m_arrowD1F, m_arrowD2F, m_arrowG1F, m_arrowG2F, m_crossBarF, m_crossBarO, m_featureLineDF, m_featureLineDO, m_featureLineGF, m_featureLineGO, m_Text, m_Width, TestSegmentHit(), and EDA_TEXT::TextHitTest().

◆ HitTest() [2/2]

bool DIMENSION::HitTest ( const EDA_RECT aRect,
bool  aContained,
int  aAccuracy = 0 
) const
overridevirtual

Function HitTest tests if aRect intersects or is contained within the bounding box of an item.

Parameters
aRectA reference to a EDA_RECT object containing the rectangle to test.
aContainedSet to true to test for containment instead of an intersection.
aAccuracyIncrease aRect by this amount.
Returns
True if aRect contains or intersects the item bounding box.

Reimplemented from EDA_ITEM.

Definition at line 421 of file class_dimension.cpp.

422 {
423  EDA_RECT arect = aRect;
424  arect.Inflate( aAccuracy );
425 
426  EDA_RECT rect = GetBoundingBox();
427  if( aAccuracy )
428  rect.Inflate( aAccuracy );
429 
430  if( aContained )
431  return arect.Contains( rect );
432 
433  return arect.Intersects( rect );
434 }
bool Contains(const wxPoint &aPoint) const
Function Contains.
const EDA_RECT GetBoundingBox() const override
Function GetBoundingBox returns the orthogonal, bounding box of this object for display purposes.
Class EDA_RECT handles the component boundary box.
Definition: eda_rect.h:44
bool Intersects(const EDA_RECT &aRect) const
Function Intersects tests for a common area between rectangles.
EDA_RECT & Inflate(wxCoord dx, wxCoord dy)
Function Inflate inflates the rectangle horizontally by dx and vertically by dy.

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

◆ IsBrightened()

bool EDA_ITEM::IsBrightened ( ) const
inlineinherited

◆ IsConnected()

virtual bool BOARD_ITEM::IsConnected ( ) const
inlinevirtualinherited

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

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

Reimplemented in BOARD_CONNECTED_ITEM.

Definition at line 107 of file class_board_item.h.

108  {
109  return false;
110  }

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

◆ IsDragging()

bool EDA_ITEM::IsDragging ( ) const
inlineinherited

Definition at line 218 of file base_struct.h.

218 { return m_Flags & IS_DRAGGED; }
#define IS_DRAGGED
Item being dragged.
Definition: base_struct.h:109
STATUS_FLAGS m_Flags
Flag bits for editing and other uses.
Definition: base_struct.h:174

References IS_DRAGGED, and EDA_ITEM::m_Flags.

Referenced by DIALOG_EDIT_COMPONENT_IN_SCHEMATIC::DIALOG_EDIT_COMPONENT_IN_SCHEMATIC(), KIGFX::SCH_PAINTER::setColors(), and ShowClearance().

◆ IsHighlighted()

bool EDA_ITEM::IsHighlighted ( ) const
inlineinherited

Definition at line 222 of file base_struct.h.

222 { return m_Flags & HIGHLIGHTED; }
#define HIGHLIGHTED
item is drawn in normal colors, when the rest is darkened
Definition: base_struct.h:129
STATUS_FLAGS m_Flags
Flag bits for editing and other uses.
Definition: base_struct.h:174

References HIGHLIGHTED, and EDA_ITEM::m_Flags.

Referenced by KIGFX::PCB_RENDER_SETTINGS::GetColor(), and KIGFX::SCH_PAINTER::getRenderColor().

◆ IsLocked()

virtual bool BOARD_ITEM::IsLocked ( ) const
inlinevirtualinherited

Function IsLocked.

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

Reimplemented in MODULE, and TRACK.

Definition at line 192 of file class_board_item.h.

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

Referenced by PCBNEW_CONTROL::DeleteItemCursor(), EditToolSelectionFilter(), and GENERAL_COLLECTOR::Inspect().

◆ IsModified()

bool EDA_ITEM::IsModified ( ) const
inlineinherited

Definition at line 216 of file base_struct.h.

216 { return m_Flags & IS_CHANGED; }
#define IS_CHANGED
std::function passed to nested users by ref, avoids copying std::function
Definition: base_struct.h:103
STATUS_FLAGS m_Flags
Flag bits for editing and other uses.
Definition: base_struct.h:174

References IS_CHANGED, and EDA_ITEM::m_Flags.

Referenced by PCB_EDIT_FRAME::OpenProjectFiles().

◆ IsMoving()

◆ IsNew()

◆ IsOnLayer()

virtual bool BOARD_ITEM::IsOnLayer ( PCB_LAYER_ID  aLayer) const
inlinevirtualinherited

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

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

Parameters
aLayerThe layer to test for.
Returns
bool - true if on given layer, else false.

Reimplemented in D_PAD, VIA, ZONE_CONTAINER, and MARKER_PCB.

Definition at line 172 of file class_board_item.h.

173  {
174  return m_Layer == aLayer;
175  }
PCB_LAYER_ID m_Layer

References BOARD_ITEM::m_Layer.

Referenced by CINFO3D_VISU::createLayers(), GENERAL_COLLECTOR::Inspect(), ZONE_CONTAINER::IsOnLayer(), and AR_MATRIX::TraceSegmentPcb().

◆ IsReplaceable()

virtual bool EDA_ITEM::IsReplaceable ( ) const
inlinevirtualinherited

Function IsReplaceable.

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

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

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

Definition at line 523 of file base_struct.h.

523 { return false; }

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

◆ IsResized()

bool EDA_ITEM::IsResized ( ) const
inlineinherited

Definition at line 221 of file base_struct.h.

221 { return m_Flags & IS_RESIZED; }
STATUS_FLAGS m_Flags
Flag bits for editing and other uses.
Definition: base_struct.h:174
#define IS_RESIZED
Item being resized.
Definition: base_struct.h:108

References IS_RESIZED, and EDA_ITEM::m_Flags.

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

◆ IsSelected()

◆ IsTrack()

bool BOARD_ITEM::IsTrack ( ) const
inlineinherited

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

form of testing.

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

Definition at line 183 of file class_board_item.h.

184  {
185  return ( Type() == PCB_TRACE_T ) || ( Type() == PCB_VIA_T );
186  }
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
KICAD_T Type() const
Function Type()
Definition: base_struct.h:197

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

◆ IsType()

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

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

Parameters
aScanTypesList of item types
Returns
true if the item type is contained in the list aScanTypes

Reimplemented in SCH_LABEL, SCH_FIELD, and SCH_LINE.

Definition at line 280 of file base_struct.h.

281  {
282  if( aScanTypes[0] == SCH_LOCATE_ANY_T )
283  return true;
284 
285  for( const KICAD_T* p = aScanTypes; *p != EOT; ++p )
286  {
287  if( m_StructType == *p )
288  return true;
289  }
290 
291  return false;
292  }
KICAD_T m_StructType
Run time identification, keep private so it can never be changed after a constructor sets it.
Definition: base_struct.h:159
search types array terminator (End Of Types)
Definition: typeinfo.h:82
KICAD_T
Enum KICAD_T is the set of class identification values, stored in EDA_ITEM::m_StructType.
Definition: typeinfo.h:78

References EOT, EDA_ITEM::m_StructType, and SCH_LOCATE_ANY_T.

Referenced by SCH_SCREEN::GetItem(), SCH_LINE_WIRE_BUS_TOOL::IsDrawingBus(), SCH_LINE_WIRE_BUS_TOOL::IsDrawingLine(), SCH_LINE_WIRE_BUS_TOOL::IsDrawingWire(), SCH_LINE::IsType(), SCH_FIELD::IsType(), SCH_LABEL::IsType(), EE_POINT_EDITOR::Main(), PL_POINT_EDITOR::Main(), EE_SELECTION_TOOL::RequestSelection(), PCB_BASE_EDIT_FRAME::SaveCopyInUndoList(), EDA_ITEM::Visit(), and DIALOG_GLOBAL_EDIT_TEXT_AND_GRAPHICS::visitItem().

◆ IsWireImage()

bool EDA_ITEM::IsWireImage ( ) const
inlineinherited

Definition at line 219 of file base_struct.h.

219 { return m_Flags & IS_WIRE_IMAGE; }
#define IS_WIRE_IMAGE
Item to be drawn as wireframe while editing.
Definition: base_struct.h:111
STATUS_FLAGS m_Flags
Flag bits for editing and other uses.
Definition: base_struct.h:174

References IS_WIRE_IMAGE, and EDA_ITEM::m_Flags.

◆ IterateForward() [1/2]

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

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 404 of file base_struct.h.

409  {
410  for( EDA_ITEM* p = listStart; p; p = p->Pnext )
411  {
412  if( SEARCH_QUIT == p->Visit( inspector, testData, scanTypes ) )
413  return SEARCH_QUIT;
414  }
415 
416  return SEARCH_CONTINUE;
417  }
Class EDA_ITEM is a base class for most all the KiCad significant classes, used in schematics and boa...
Definition: base_struct.h:150
EDA_ITEM * Pnext
next in linked list
Definition: base_struct.h:163

References EDA_ITEM::Pnext, SEARCH_CONTINUE, and SEARCH_QUIT.

Referenced by EE_COLLECTOR::Collect(), EE_TYPE_COLLECTOR::Collect(), nextMatch(), EE_SELECTION_TOOL::RebuildSelection(), SCH_EDITOR_CONTROL::UpdateFind(), GERBER_FILE_IMAGE::Visit(), and BOARD::Visit().

◆ IterateForward() [2/2]

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

IterateForward( EDA_ITEM*, INSPECTOR, void*, const KICAD_T )

IterateForward( EDA_ITEM*, INSPECTOR, void*, const KICAD_T )

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

Definition at line 425 of file base_struct.h.

429  {
430  for( auto it : aList )
431  {
432  if( static_cast<EDA_ITEM*>( it )->Visit( inspector, testData, scanTypes ) == SEARCH_QUIT )
433  return SEARCH_QUIT;
434  }
435 
436  return SEARCH_CONTINUE;
437  }
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...

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

◆ Matches() [1/2]

virtual bool EDA_ITEM::Matches ( wxFindReplaceData &  aSearchData,
void *  aAuxData 
)
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.
Returns
True if the item's text matches the search criteria in aSearchData.

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

Definition at line 479 of file base_struct.h.

480  {
481  return false;
482  }

Referenced by SCH_EDITOR_CONTROL::HasMatch(), SCH_MARKER::Matches(), LIB_PIN::Matches(), SCH_TEXT::Matches(), SCH_SHEET_PIN::Matches(), SCH_FIELD::Matches(), SCH_SHEET::Matches(), nextMatch(), SCH_EDITOR_CONTROL::ReplaceAndFindNext(), and SCH_EDITOR_CONTROL::UpdateFind().

◆ Matches() [2/2]

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

Function Matches compares aText against search criteria in aSearchData.

This is a helper function for simplify derived class logic.

Parameters
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 160 of file base_struct.cpp.

161 {
162  wxString text = aText;
163  wxString searchText = aSearchData.GetFindString();
164 
165  // Don't match if searching for replaceable item and the item doesn't support text replace.
166  if( (aSearchData.GetFlags() & FR_SEARCH_REPLACE) && !IsReplaceable() )
167  return false;
168 
169  if( aSearchData.GetFlags() & wxFR_WHOLEWORD )
170  return aText.IsSameAs( searchText, aSearchData.GetFlags() & wxFR_MATCHCASE );
171 
172  if( aSearchData.GetFlags() & FR_MATCH_WILDCARD )
173  {
174  if( aSearchData.GetFlags() & wxFR_MATCHCASE )
175  return text.Matches( searchText );
176 
177  return text.MakeUpper().Matches( searchText.MakeUpper() );
178  }
179 
180  if( aSearchData.GetFlags() & wxFR_MATCHCASE )
181  return aText.Find( searchText ) != wxNOT_FOUND;
182 
183  return text.MakeUpper().Find( searchText.MakeUpper() ) != wxNOT_FOUND;
184 }
Perform search using simple wild card matching (* & ?).
Perform a search for a item that has replaceable text.
virtual bool IsReplaceable() const
Function IsReplaceable.
Definition: base_struct.h:523

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

◆ Mirror()

void DIMENSION::Mirror ( const wxPoint &  axis_pos,
bool  aMirrorLeftRight = false 
)

Function Mirror Mirror the Dimension , relative to a given horizontal axis the text is not mirrored.

only its position (and angle) is mirrored the layer is not changed

Parameters
axis_pos: vertical axis position

Definition at line 148 of file class_dimension.cpp.

149 {
150  int axis = aMirrorLeftRight ? axis_pos.x : axis_pos.y;
151  wxPoint newPos = m_Text.GetTextPos();
152 
153 #define INVERT( pos ) (pos) = axis - ( (pos) - axis )
154 
155  if( aMirrorLeftRight )
156  INVERT( newPos.x );
157  else
158  INVERT( newPos.y );
159 
160  m_Text.SetTextPos( newPos );
161 
162  // invert angle
164 
165  if( aMirrorLeftRight )
166  {
167  INVERT( m_crossBarO.y );
168  INVERT( m_crossBarF.y );
169  INVERT( m_featureLineGO.y );
170  INVERT( m_featureLineGF.y );
171  INVERT( m_featureLineDO.y );
172  INVERT( m_featureLineDF.y );
173  INVERT( m_arrowG1F.y );
174  INVERT( m_arrowG2F.y );
175  INVERT( m_arrowD1F.y );
176  INVERT( m_arrowD2F.y );
177  }
178  else
179  {
180  INVERT( m_crossBarO.y );
181  INVERT( m_crossBarF.y );
182  INVERT( m_featureLineGO.y );
183  INVERT( m_featureLineGF.y );
184  INVERT( m_featureLineDO.y );
185  INVERT( m_featureLineDF.y );
186  INVERT( m_arrowG1F.y );
187  INVERT( m_arrowG2F.y );
188  INVERT( m_arrowD1F.y );
189  INVERT( m_arrowD2F.y );
190  }
191 }
void SetTextAngle(double aAngle)
wxPoint m_crossBarF
wxPoint m_arrowD1F
void SetTextPos(const wxPoint &aPoint)
Definition: eda_text.h:217
double GetTextAngle() const
Definition: eda_text.h:158
TEXTE_PCB m_Text
wxPoint m_featureLineDF
wxPoint m_featureLineGO
wxPoint m_arrowG1F
wxPoint m_arrowD2F
wxPoint m_arrowG2F
#define INVERT(pos)
const wxPoint & GetTextPos() const
Definition: eda_text.h:218
wxPoint m_crossBarO
wxPoint m_featureLineDO
wxPoint m_featureLineGF

References EDA_TEXT::GetTextAngle(), EDA_TEXT::GetTextPos(), INVERT, m_arrowD1F, m_arrowD2F, m_arrowG1F, m_arrowG2F, m_crossBarF, m_crossBarO, m_featureLineDF, m_featureLineDO, m_featureLineGF, m_featureLineGO, m_Text, TEXTE_PCB::SetTextAngle(), and EDA_TEXT::SetTextPos().

Referenced by Flip().

◆ Move() [1/2]

void DIMENSION::Move ( const wxPoint &  offset)
overridevirtual

Function Move.

Parameters
offset: moving vector

Reimplemented from BOARD_ITEM.

Definition at line 92 of file class_dimension.cpp.

93 {
94  m_Text.Offset( offset );
95 
96  m_crossBarO += offset;
97  m_crossBarF += offset;
98  m_featureLineGO += offset;
99  m_featureLineGF += offset;
100  m_featureLineDO += offset;
101  m_featureLineDF += offset;
102  m_arrowG1F += offset;
103  m_arrowG2F += offset;
104  m_arrowD1F += offset;
105  m_arrowD2F += offset;
106 }
void Offset(const wxPoint &aOffset)
Definition: eda_text.h:223
wxPoint m_crossBarF
wxPoint m_arrowD1F
TEXTE_PCB m_Text
wxPoint m_featureLineDF
wxPoint m_featureLineGO
wxPoint m_arrowG1F
wxPoint m_arrowD2F
wxPoint m_arrowG2F
wxPoint m_crossBarO
wxPoint m_featureLineDO
wxPoint m_featureLineGF

References m_arrowD1F, m_arrowD2F, m_arrowG1F, m_arrowG2F, m_crossBarF, m_crossBarO, m_featureLineDF, m_featureLineDO, m_featureLineGF, m_featureLineGO, m_Text, and EDA_TEXT::Offset().

◆ Move() [2/2]

void BOARD_ITEM::Move ( const VECTOR2I aMoveVector)
inlineinherited

Definition at line 238 of file class_board_item.h.

239  {
240  Move( wxPoint( aMoveVector.x, aMoveVector.y ) );
241  }
virtual void Move(const wxPoint &aMoveVector)
Function Move move this object.

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

◆ Next()

◆ operator<()

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

Test if another item is less than this object.

Parameters
aItem- Item to compare against.
Returns
- True if aItem is less than the item.

Definition at line 217 of file base_struct.cpp.

218 {
219  wxFAIL_MSG( wxString::Format( wxT( "Less than operator not defined for item type %s." ),
220  GetChars( GetClass() ) ) );
221 
222  return false;
223 }
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:101
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

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

◆ Print()

void DIMENSION::Print ( PCB_BASE_FRAME aFrame,
wxDC *  DC,
const wxPoint &  offset = ZeroOffset 
)
overridevirtual

Function Print BOARD_ITEMs have their own color information.

Implements BOARD_ITEM.

Definition at line 342 of file class_dimension.cpp.

343 {
344  BOARD* brd = GetBoard();
345 
346  if( brd->IsLayerVisible( m_Layer ) == false )
347  return;
348 
349  m_Text.Print( aFrame, DC, offset );
350 
351  auto gcolor = aFrame->Settings().Colors().GetLayerColor( m_Layer );
352  auto displ_opts = (PCB_DISPLAY_OPTIONS*)( aFrame->GetDisplayOptions() );
353  bool filled = displ_opts ? displ_opts->m_DisplayDrawItemsFill : FILLED;
354  int width = m_Width;
355 
356  if( filled )
357  {
358  GRLine( nullptr, DC, m_crossBarO + offset, m_crossBarF + offset, width, gcolor );
359  GRLine( nullptr, DC, m_featureLineGO + offset, m_featureLineGF + offset, width, gcolor );
360  GRLine( nullptr, DC, m_featureLineDO + offset, m_featureLineDF + offset, width, gcolor );
361  GRLine( nullptr, DC, m_crossBarF + offset, m_arrowD1F + offset, width, gcolor );
362  GRLine( nullptr, DC, m_crossBarF + offset, m_arrowD2F + offset, width, gcolor );
363  GRLine( nullptr, DC, m_crossBarO + offset, m_arrowG1F + offset, width, gcolor );
364  GRLine( nullptr, DC, m_crossBarO + offset, m_arrowG2F + offset, width, gcolor );
365  }
366  else
367  {
368  GRCSegm( nullptr, DC, m_crossBarO + offset, m_crossBarF + offset, width, gcolor );
369  GRCSegm( nullptr, DC, m_featureLineGO + offset, m_featureLineGF + offset, width, gcolor );
370  GRCSegm( nullptr, DC, m_featureLineDO + offset, m_featureLineDF + offset, width, gcolor );
371  GRCSegm( nullptr, DC, m_crossBarF + offset, m_arrowD1F + offset, width, gcolor );
372  GRCSegm( nullptr, DC, m_crossBarF + offset, m_arrowD2F + offset, width, gcolor );
373  GRCSegm( nullptr, DC, m_crossBarO + offset, m_arrowG1F + offset, width, gcolor );
374  GRCSegm( nullptr, DC, m_crossBarO + offset, m_arrowG2F + offset, width, gcolor );
375  }
376 }
wxPoint m_crossBarF
wxPoint m_arrowD1F
TEXTE_PCB m_Text
void GRCSegm(EDA_RECT *ClipBox, wxDC *DC, int x1, int y1, int x2, int y2, int width, int aPenSize, COLOR4D Color)
Definition: gr_basic.cpp:312
wxPoint m_featureLineDF
void * GetDisplayOptions() override
Function GetDisplayOptions returns the display options current in use Display options are relative to...
wxPoint m_featureLineGO
PCB_LAYER_ID m_Layer
COLOR4D GetLayerColor(LAYER_NUM aLayer) const
Function GetLayerColor.
Class PCB_DISPLAY_OPTIONS handles display options like enable/disable some optional drawings.
PCB_GENERAL_SETTINGS & Settings()
wxPoint m_arrowG1F
virtual BOARD * GetBoard() const
Function GetBoard returns the BOARD in which this BOARD_ITEM resides, or NULL if none.
wxPoint m_arrowD2F
wxPoint m_arrowG2F
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:230
COLORS_DESIGN_SETTINGS & Colors()
int m_Width
Line width.
void Print(PCB_BASE_FRAME *aFrame, wxDC *DC, const wxPoint &offset=ZeroOffset) override
Function Print BOARD_ITEMs have their own color information.
bool IsLayerVisible(PCB_LAYER_ID aLayer) const
Function IsLayerVisible is a proxy function that calls the correspondent function in m_BoardSettings ...
Definition: class_board.h:459
Class BOARD holds information pertinent to a Pcbnew printed circuit board.
Definition: class_board.h:161
wxPoint m_crossBarO
wxPoint m_featureLineDO
wxPoint m_featureLineGF

References PCB_GENERAL_SETTINGS::Colors(), FILLED, BOARD_ITEM::GetBoard(), PCB_BASE_FRAME::GetDisplayOptions(), COLORS_DESIGN_SETTINGS::GetLayerColor(), GRCSegm(), GRLine(), BOARD::IsLayerVisible(), m_arrowD1F, m_arrowD2F, m_arrowG1F, m_arrowG2F, m_crossBarF, m_crossBarO, m_featureLineDF, m_featureLineDO, m_featureLineGF, m_featureLineGO, BOARD_ITEM::m_Layer, m_Text, m_Width, TEXTE_PCB::Print(), and PCB_BASE_FRAME::Settings().

◆ Replace() [1/2]

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

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

Parameters
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 187 of file base_struct.cpp.

188 {
189  wxCHECK_MSG( IsReplaceable(), false,
190  wxT( "Attempt to replace text in <" ) + GetClass() + wxT( "> item." ) );
191 
192  wxString searchString = (aSearchData.GetFlags() & wxFR_MATCHCASE) ? aText : aText.Upper();
193 
194  int result = searchString.Find( (aSearchData.GetFlags() & wxFR_MATCHCASE) ?
195  aSearchData.GetFindString() :
196  aSearchData.GetFindString().Upper() );
197 
198  if( result == wxNOT_FOUND )
199  return false;
200 
201  wxString prefix = aText.Left( result );
202  wxString suffix;
203 
204  if( aSearchData.GetFindString().length() + result < aText.length() )
205  suffix = aText.Right( aText.length() - ( aSearchData.GetFindString().length() + result ) );
206 
207  wxLogTrace( traceFindReplace, wxT( "Replacing '%s', prefix '%s', replace '%s', suffix '%s'." ),
208  GetChars( aText ), GetChars( prefix ), GetChars( aSearchData.GetReplaceString() ),
209  GetChars( suffix ) );
210 
211  aText = prefix + aSearchData.GetReplaceString() + suffix;
212 
213  return true;
214 }
const wxChar *const traceFindReplace
Flag to enable find and replace debug tracing.
static const wxChar * GetChars(const wxString &s)
Function GetChars returns a wxChar* to the actual wxChar* data within a wxString, and is helpful for ...
Definition: macros.h:101
virtual wxString GetClass() const =0
Function GetClass returns the class name.
virtual bool IsReplaceable() const
Function IsReplaceable.
Definition: base_struct.h:523

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

Referenced by FOOTPRINT_INFO_GENERATOR::GetHtmlFieldRow(), SCH_TEXT::Replace(), SCH_SHEET_PIN::Replace(), SCH_FIELD::Replace(), SCH_SHEET::Replace(), and SCH_EDITOR_CONTROL::ReplaceAndFindNext().

◆ Replace() [2/2]

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

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

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

Parameters
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_FIELD, SCH_SHEET_PIN, and SCH_TEXT.

Definition at line 511 of file base_struct.h.

511 { return false; }

◆ Rotate() [1/2]

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

Function Rotate Rotate this object.

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

Reimplemented from BOARD_ITEM.

Definition at line 109 of file class_dimension.cpp.

110 {
111  wxPoint tmp = m_Text.GetTextPos();
112  RotatePoint( &tmp, aRotCentre, aAngle );
113  m_Text.SetTextPos( tmp );
114 
115  double newAngle = m_Text.GetTextAngle() + aAngle;
116 
117  if( newAngle >= 3600 )
118  newAngle -= 3600;
119 
120  if( newAngle > 900 && newAngle < 2700 )
121  newAngle -= 1800;
122 
123  m_Text.SetTextAngle( newAngle );
124 
125  RotatePoint( &m_crossBarO, aRotCentre, aAngle );
126  RotatePoint( &m_crossBarF, aRotCentre, aAngle );
127  RotatePoint( &m_featureLineGO, aRotCentre, aAngle );
128  RotatePoint( &m_featureLineGF, aRotCentre, aAngle );
129  RotatePoint( &m_featureLineDO, aRotCentre, aAngle );
130  RotatePoint( &m_featureLineDF, aRotCentre, aAngle );
131  RotatePoint( &m_arrowG1F, aRotCentre, aAngle );
132  RotatePoint( &m_arrowG2F, aRotCentre, aAngle );
133  RotatePoint( &m_arrowD1F, aRotCentre, aAngle );
134  RotatePoint( &m_arrowD2F, aRotCentre, aAngle );
135 }
void SetTextAngle(double aAngle)
wxPoint m_crossBarF
wxPoint m_arrowD1F
void SetTextPos(const wxPoint &aPoint)
Definition: eda_text.h:217
double GetTextAngle() const
Definition: eda_text.h:158
TEXTE_PCB m_Text
wxPoint m_featureLineDF
void RotatePoint(int *pX, int *pY, double angle)
Definition: trigo.cpp:229
wxPoint m_featureLineGO
wxPoint m_arrowG1F
wxPoint m_arrowD2F
wxPoint m_arrowG2F
const wxPoint & GetTextPos() const
Definition: eda_text.h:218
wxPoint m_crossBarO
wxPoint m_featureLineDO
wxPoint m_featureLineGF

References EDA_TEXT::GetTextAngle(), EDA_TEXT::GetTextPos(), m_arrowD1F, m_arrowD2F, m_arrowG1F, m_arrowG2F, m_crossBarF, m_crossBarO, m_featureLineDF, m_featureLineDO, m_featureLineGF, m_featureLineGO, m_Text, RotatePoint(), TEXTE_PCB::SetTextAngle(), and EDA_TEXT::SetTextPos().

◆ Rotate() [2/2]

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

Definition at line 254 of file class_board_item.h.

255  {
256  Rotate( wxPoint( aRotCentre.x, aRotCentre.y ), aAngle );
257  }
virtual void Rotate(const wxPoint &aRotCentre, double aAngle)
Function Rotate Rotate this object.

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

◆ SetBack()

void EDA_ITEM::SetBack ( EDA_ITEM aBack)
inlineinherited

Definition at line 211 of file base_struct.h.

211 { Pback = aBack; }
EDA_ITEM * Pback
previous in linked list
Definition: base_struct.h:164

References EDA_ITEM::Pback.

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

◆ SetBrightened()

void EDA_ITEM::SetBrightened ( )
inlineinherited

Definition at line 228 of file base_struct.h.

228 { SetFlags( BRIGHTENED ); }
void SetFlags(STATUS_FLAGS aMask)
Definition: base_struct.h:252
#define BRIGHTENED
item is drawn with a bright contour
Definition: base_struct.h:130

References BRIGHTENED, and EDA_ITEM::SetFlags().

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

◆ SetEnd()

void DIMENSION::SetEnd ( const wxPoint &  aEnd)

Function SetEnd Sets a new end of the crossbar line.

All remaining lines are adjusted after that.

Parameters
aEndis the new point to be used as the new end of the crossbar line.

Definition at line 202 of file class_dimension.cpp.

203 {
204  m_featureLineDO = aEnd;
205 
207 }
void AdjustDimensionDetails()
Function AdjustDimensionDetails Calculate coordinates of segments used to draw the dimension.
wxPoint m_featureLineDO

References AdjustDimensionDetails(), and m_featureLineDO.

Referenced by DRAWING_TOOL::constrainDimension(), EAGLE_PLUGIN::loadPlain(), and POINT_EDITOR::updateItem().

◆ SetFlags()

void EDA_ITEM::SetFlags ( STATUS_FLAGS  aMask)
inlineinherited

Definition at line 252 of file base_struct.h.

252 { m_Flags |= aMask; }
STATUS_FLAGS m_Flags
Flag bits for editing and other uses.
Definition: base_struct.h:174

References EDA_ITEM::m_Flags.

Referenced by SCH_EAGLE_PLUGIN::addBusEntries(), PCB_BASE_FRAME::AddModuleToBoard(), PCBNEW_CONTROL::AppendBoard(), SCH_EDIT_FRAME::ConvertPart(), SCH_EDIT_FRAME::ConvertTextType(), SCH_EDIT_FRAME::CreateNewText(), LIB_PIN_TOOL::CreatePin(), SCH_EDIT_FRAME::CreateSheetPin(), SCH_LINE_WIRE_BUS_TOOL::doDrawSegments(), KIGFX::SCH_PAINTER::draw(), DRAWING_TOOL::DrawArc(), DRAWING_TOOL::DrawCircle(), DRAWING_TOOL::DrawLine(), LIB_DRAWING_TOOLS::DrawShape(), SCH_EDIT_TOOL::Duplicate(), LIB_EDIT_FRAME::GetComponentFromRedoList(), LIB_EDIT_FRAME::GetComponentFromUndoList(), SCH_MOVE_TOOL::getConnectedDragItems(), KIGFX::SCH_VIEW::HighlightItem(), EDIT_POINTS_FACTORY::Make(), SCH_SCREEN::MarkConnections(), TRACKS_CLEANER::mergeCollinearSegments(), SCH_MOVE_TOOL::moveItem(), LIB_MOVE_TOOL::moveItem(), KIGFX::ORIGIN_VIEWITEM::ORIGIN_VIEWITEM(), LIB_EDIT_TOOL::Paste(), SCH_EDITOR_CONTROL::Paste(), SCH_DRAWING_TOOLS::PlaceComponent(), SCH_DRAWING_TOOLS::PlaceImage(), PL_DRAWING_TOOLS::PlaceItem(), PCB_EDITOR_CONTROL::PlaceModule(), DRAWING_TOOL::PlaceText(), SCH_EDIT_FRAME::PutDataInPreviousState(), SCH_EDIT_TOOL::RepeatDrawItem(), LIB_PIN_TOOL::RepeatPin(), LIB_EDIT_FRAME::SaveCopyInUndoList(), EE_SELECTION_TOOL::selectMultiple(), EE_SELECTION_TOOL::SelectPoint(), SCH_EDIT_FRAME::SelectUnit(), EDA_ITEM::SetBrightened(), LIB_PIN::SetConversion(), EDA_ITEM::SetHighlighted(), EDA_ITEM::SetModified(), EDA_ITEM::SetSelected(), EDA_ITEM::SetWireImage(), SCH_DRAWING_TOOLS::SingleClickPlace(), SCH_LINE_WIRE_BUS_TOOL::startSegments(), WS_DATA_ITEM::SyncDrawItems(), WS_DATA_ITEM_TEXT::SyncDrawItems(), DIALOG_TARGET_PROPERTIES::TransferDataFromWindow(), DIALOG_TEXT_PROPERTIES::TransferDataFromWindow(), DIALOG_EDIT_COMPONENT_IN_SCHEMATIC::TransferDataFromWindow(), DIALOG_PAD_PROPERTIES::TransferDataFromWindow(), LIB_DRAWING_TOOLS::TwoClickPlace(), and SCH_DRAWING_TOOLS::TwoClickPlace().

◆ SetForceVisible()

void EDA_ITEM::SetForceVisible ( bool  aEnable)
inlineinherited

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

Parameters
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 302 of file base_struct.h.

302 { m_forceVisible = aEnable; }
bool m_forceVisible
Set to true to override the visibility setting of the item.
Definition: base_struct.h:171

References EDA_ITEM::m_forceVisible.

◆ SetHeight()

void DIMENSION::SetHeight ( int  aHeight)

Function SetHeight Sets the length of feature lines.

Parameters
aHeightis the new height.

Definition at line 210 of file class_dimension.cpp.

211 {
212  m_Height = aHeight;
213 
215 }
int m_Height
length of feature lines
void AdjustDimensionDetails()
Function AdjustDimensionDetails Calculate coordinates of segments used to draw the dimension.

References AdjustDimensionDetails(), and m_Height.

Referenced by EAGLE_PLUGIN::loadPlain(), and POINT_EDITOR::updateItem().

◆ SetHighlighted()

void EDA_ITEM::SetHighlighted ( )
inlineinherited

Definition at line 227 of file base_struct.h.

227 { SetFlags( HIGHLIGHTED ); }
void SetFlags(STATUS_FLAGS aMask)
Definition: base_struct.h:252
#define HIGHLIGHTED
item is drawn in normal colors, when the rest is darkened
Definition: base_struct.h:129

References HIGHLIGHTED, and EDA_ITEM::SetFlags().

◆ SetLayer()

void DIMENSION::SetLayer ( PCB_LAYER_ID  aLayer)
overridevirtual

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

Definition at line 85 of file class_dimension.cpp.

86 {
87  m_Layer = aLayer;
88  m_Text.SetLayer( aLayer );
89 }
virtual void SetLayer(PCB_LAYER_ID aLayer)
Function SetLayer sets the layer this item is on.
TEXTE_PCB m_Text
PCB_LAYER_ID m_Layer

References BOARD_ITEM::m_Layer, m_Text, and BOARD_ITEM::SetLayer().

Referenced by Flip(), and EAGLE_PLUGIN::loadPlain().

◆ SetList()

void EDA_ITEM::SetList ( DHEAD aList)
inlineinherited

Definition at line 213 of file base_struct.h.

213 { m_List = aList; }
DHEAD * m_List
which DLIST I am on.
Definition: base_struct.h:165

References EDA_ITEM::m_List.

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

◆ SetLocked()

virtual void BOARD_ITEM::SetLocked ( bool  aLocked)
inlinevirtualinherited

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

Reimplemented in MODULE, and TRACK.

Definition at line 202 of file class_board_item.h.

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

◆ SetModified()

◆ SetNext()

void EDA_ITEM::SetNext ( EDA_ITEM aNext)
inlineinherited

Definition at line 210 of file base_struct.h.

210 { Pnext = aNext; }
EDA_ITEM * Pnext
next in linked list
Definition: base_struct.h:163

References EDA_ITEM::Pnext.

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

◆ SetOrigin()

void DIMENSION::SetOrigin ( const wxPoint &  aOrigin)

Function SetOrigin Sets a new origin of the crossbar line.

All remaining lines are adjusted after that.

Parameters
aOriginis the new point to be used as the new origin of the crossbar line.

Definition at line 194 of file class_dimension.cpp.

195 {
196  m_featureLineGO = aOrigin;
197 
199 }
wxPoint m_featureLineGO
void AdjustDimensionDetails()
Function AdjustDimensionDetails Calculate coordinates of segments used to draw the dimension.

References AdjustDimensionDetails(), and m_featureLineGO.

Referenced by EAGLE_PLUGIN::loadPlain(), and POINT_EDITOR::updateItem().

◆ SetParent()

◆ SetPosition()

void DIMENSION::SetPosition ( const wxPoint &  aPos)
overridevirtual

Implements BOARD_ITEM.

Definition at line 61 of file class_dimension.cpp.

62 {
63  m_Text.SetTextPos( aPos );
64 }
void SetTextPos(const wxPoint &aPoint)
Definition: eda_text.h:217
TEXTE_PCB m_Text

References m_Text, and EDA_TEXT::SetTextPos().

◆ SetSelected()

void EDA_ITEM::SetSelected ( )
inlineinherited

◆ SetShape()

void DIMENSION::SetShape ( int  aShape)
inline

Definition at line 106 of file class_dimension.h.

106 { m_Shape = aShape; }
int m_Shape
Currently always 0.

References m_Shape.

◆ SetState()

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

Definition at line 241 of file base_struct.h.

242  {
243  if( state )
244  m_Status |= type; // state = ON or OFF
245  else
246  m_Status &= ~type;
247  }
STATUS_FLAGS m_Status
Definition: base_struct.h:160

References EDA_ITEM::m_Status.

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

◆ SetStatus()

void EDA_ITEM::SetStatus ( STATUS_FLAGS  aStatus)
inlineinherited

Definition at line 250 of file base_struct.h.

250 { m_Status = aStatus; }
STATUS_FLAGS m_Status
Definition: base_struct.h:160

References EDA_ITEM::m_Status.

Referenced by BOARD_NETLIST_UPDATER::UpdateNetlist().

◆ SetText()

void DIMENSION::SetText ( const wxString &  NewText)

Definition at line 73 of file class_dimension.cpp.

74 {
75  m_Text.SetText( aNewText );
76 }
TEXTE_PCB m_Text
virtual void SetText(const wxString &aText)
Definition: eda_text.cpp:112

References m_Text, and EDA_TEXT::SetText().

Referenced by AdjustDimensionDetails().

◆ SetTextSize()

void DIMENSION::SetTextSize ( const wxSize &  aTextSize)
inline

Definition at line 99 of file class_dimension.h.

100  {
101  m_Text.SetTextSize( aTextSize );
102  }
TEXTE_PCB m_Text
void SetTextSize(const wxSize &aNewSize)
Definition: eda_text.h:208

References m_Text, and EDA_TEXT::SetTextSize().

◆ SetTimeStamp()

void EDA_ITEM::SetTimeStamp ( timestamp_t  aNewTimeStamp)
inlineinherited

Definition at line 202 of file base_struct.h.

202 { m_TimeStamp = aNewTimeStamp; }
timestamp_t m_TimeStamp
Time stamp used for logical links.
Definition: base_struct.h:168

References EDA_ITEM::m_TimeStamp.

Referenced by FOOTPRINT_VIEWER_FRAME::AddFootprintToPCB(), PCB_BASE_FRAME::AddModuleToBoard(), BOARD_NETLIST_UPDATER::addNewComponent(), PCAD2KICAD::PCB_TEXT::AddToBoard(), PCAD2KICAD::PCB_LINE::AddToBoard(), PCAD2KICAD::PCB_ARC::AddToBoard(), PCAD2KICAD::PCB_PAD::AddToBoard(), PCAD2KICAD::PCB_POLYGON::AddToBoard(), PCAD2KICAD::PCB_MODULE::AddToBoard(), SCH_EDIT_FRAME::AppendSchematic(), Diagnose(), SCH_EDIT_TOOL::Duplicate(), SCH_ITEM::Duplicate(), DIALOG_FOOTPRINT_BOARD_EDITOR::EditFootprint(), PCB_EDIT_FRAME::Exchange_Module(), PCB_IO::FootprintSave(), EDA_ITEM::initVars(), BOARD::InsertArea(), LEGACY_PLUGIN::loadMODULE(), LEGACY_PLUGIN::loadPCB_TARGET(), LEGACY_PLUGIN::loadPCB_TEXT(), EAGLE_PLUGIN::loadPlain(), EAGLE_PLUGIN::loadPolygon(), EAGLE_PLUGIN::loadSignals(), LEGACY_PLUGIN::loadTrackList(), EDA_ITEM::operator=(), EAGLE_PLUGIN::packageCircle(), EAGLE_PLUGIN::packagePolygon(), EAGLE_PLUGIN::packageRectangle(), EAGLE_PLUGIN::packageText(), PCB_PARSER::parseDIMENSION(), SCH_EDITOR_CONTROL::Paste(), PCB_EDITOR_CONTROL::PlaceModule(), SCH_EDIT_TOOL::RepeatDrawItem(), SCH_SCREENS::ReplaceDuplicateTimeStamps(), FOOTPRINT_EDIT_FRAME::SaveFootprintToBoard(), SCH_SHEET::SCH_SHEET(), SCH_COMPONENT::SetTimeStamp(), SimilarLabelsDiagnose(), SwapItemData(), TestDuplicateSheetNames(), DIALOG_ERC::TestErc(), and TestMultiunitFootprints().

◆ SetUnits()

void DIMENSION::SetUnits ( EDA_UNITS_T  aUnits,
bool  aUseMils 
)
inline

Definition at line 190 of file class_dimension.h.

191  {
192  m_Unit = aUnits;
193  m_UseMils = aUseMils;
194  }
EDA_UNITS_T m_Unit
0 = inches, 1 = mm
bool m_UseMils
If inches, use mils.

References m_Unit, and m_UseMils.

Referenced by EAGLE_PLUGIN::loadPlain(), and DIALOG_TEXT_PROPERTIES::TransferDataFromWindow().

◆ SetValue()

void DIMENSION::SetValue ( int  aValue)
inline

Definition at line 91 of file class_dimension.h.

91 { m_Value = aValue; }
int m_Value
value of PCB dimensions.

References m_Value.

◆ SetWidth()

void DIMENSION::SetWidth ( int  aWidth)
inline

Definition at line 110 of file class_dimension.h.

110 { m_Width = aWidth; }
int m_Width
Line width.

References m_Width.

Referenced by EAGLE_PLUGIN::loadPlain().

◆ SetWireImage()

void EDA_ITEM::SetWireImage ( )
inlineinherited

Definition at line 225 of file base_struct.h.

225 { SetFlags( IS_WIRE_IMAGE ); }
void SetFlags(STATUS_FLAGS aMask)
Definition: base_struct.h:252
#define IS_WIRE_IMAGE
Item to be drawn as wireframe while editing.
Definition: base_struct.h:111

References IS_WIRE_IMAGE, and EDA_ITEM::SetFlags().

◆ ShowShape()

wxString BOARD_ITEM::ShowShape ( STROKE_T  aShape)
staticinherited

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

Definition at line 39 of file class_board_item.cpp.

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.
#define _(s)

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

◆ Sort()

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

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

Parameters
aLeftThe left hand item to compare.
aRightThe right hand item to compare.
Returns
True if aLeft is less than aRight.

Definition at line 542 of file base_struct.h.

542 { return *aLeft < *aRight; }

◆ SwapData()

void DIMENSION::SwapData ( BOARD_ITEM aImage)
overridevirtual

Swap data between aItem and aImage.

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

Parameters
aImage= the item image which contains data to swap

Reimplemented from BOARD_ITEM.

Definition at line 513 of file class_dimension.cpp.

514 {
515  assert( aImage->Type() == PCB_DIMENSION_T );
516 
517  std::swap( *((DIMENSION*) this), *((DIMENSION*) aImage) );
518 }
class DIMENSION, a dimension (graphic item)
Definition: typeinfo.h:98
Class DIMENSION.
KICAD_T Type() const
Function Type()
Definition: base_struct.h:197

References PCB_DIMENSION_T, and EDA_ITEM::Type().

◆ Text() [1/2]

◆ Text() [2/2]

TEXTE_PCB& DIMENSION::Text ( ) const
inline

Definition at line 200 of file class_dimension.h.

200 { return *(const_cast<TEXTE_PCB*> (&m_Text)); }
TEXTE_PCB m_Text

References m_Text.

◆ TransformShapeWithClearanceToPolygon()

void BOARD_ITEM::TransformShapeWithClearanceToPolygon ( SHAPE_POLY_SET aCornerBuffer,
int  aClearanceValue,
int  aError = ARC_LOW_DEF,
bool  ignoreLineWidth = false 
) const
virtualinherited

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

Parameters
aCornerBuffer= a buffer to store the polygon
aClearanceValue= the clearance around the pad
aError= the maximum deviation from true circle
ignoreLineWidth= used for edge cut items where the line width is only for visualization

Reimplemented in D_PAD, ZONE_CONTAINER, DRAWSEGMENT, and TRACK.

Definition at line 143 of file class_board_item.cpp.

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

◆ Type()

KICAD_T EDA_ITEM::Type ( ) const
inlineinherited

Function Type()

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

Returns
KICAD_T - the type of object.

Definition at line 197 of file base_struct.h.

198  {
199  return m_StructType;
200  }
KICAD_T m_StructType
Run time identification, keep private so it can never be changed after a constructor sets it.
Definition: base_struct.h:159

References EDA_ITEM::m_StructType.

Referenced by MODULE::Add(), CN_CONNECTIVITY_ALGO::Add(), BOARD::Add(), CN_CLUSTER::Add(), POINT_EDITOR::addCorner(), CONNECTION_SUBGRAPH::AddItem(), SCH_EDIT_FRAME::AddItemToScreenAndUndoList(), SCH_LINE_WIRE_BUS_TOOL::AddJunctionsIfNeeded(), ZONE_FILLER::addKnockout(), SCH_SHEET::AddPin(), ALIGN_DISTRIBUTE_TOOL::AlignBottom(), ALIGN_DISTRIBUTE_TOOL::AlignCenterX(), ALIGN_DISTRIBUTE_TOOL::AlignCenterY(), ALIGN_DISTRIBUTE_TOOL::AlignTop(), CN_ITEM::AnchorCount(), CONNECTION_GRAPH::buildConnectionGraph(), HIERARCHY_NAVIG_DLG::buildHierarchyTree(), SCH_SCREENS::buildScreenList(), SCH_SHEET_LIST::BuildSheetList(), calcArea(), calcMaxArea(), POINT_EDITOR::canAddCorner(), SCH_JUNCTION::CanConnect(), SCH_NO_CONNECT::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(), SCH_SCREENS::ChangeSymbolLibNickname(), CN_VISITOR::checkZoneItemConnection(), TEXTE_PCB::ClassOf(), EDGE_MODULE::ClassOf(), BOARD_CONNECTED_ITEM::ClassOf(), PCB_TARGET::ClassOf(), TEXTE_MODULE::ClassOf(), ZONE_CONTAINER::ClassOf(), DRAWSEGMENT::ClassOf(), MARKER_PCB::ClassOf(), TRACK::ClassOf(), ClassOf(), NETINFO_ITEM::ClassOf(), MODULE::ClassOf(), SCH_COMPONENT::ClassOf(), D_PAD::ClassOf(), BOARD::ClassOf(), VIA::ClassOf(), SCH_SHEET::CleanupSheet(), EE_COLLECTOR::Collect(), LIB_RECTANGLE::compare(), LIB_CIRCLE::compare(), LIB_BEZIER::compare(), LIB_POLYLINE::compare(), LIB_TEXT::compare(), LIB_ARC::compare(), LIB_FIELD::compare(), LIB_PIN::compare(), SCH_SHEET::ComponentCount(), GRID_HELPER::computeAnchors(), SCH_BUS_WIRE_ENTRY::ConnectionPropagatesTo(), SCH_EDIT_FRAME::ConvertTextType(), SCH_SCREEN::CountConnectedItems(), SCH_SHEET::CountSheets(), MODULE::CoverageRatio(), CINFO3D_VISU::createLayers(), SCH_EDIT_FRAME::CreateNewText(), CINFO3D_VISU::createNewTrack(), D_PAD::D_PAD(), SCH_SCREENS::DeleteAllMarkers(), SCH_SCREEN::DeleteItem(), DIALOG_LABEL_EDITOR::DIALOG_LABEL_EDITOR(), DIALOG_SCH_EDIT_ONE_FIELD::DIALOG_SCH_EDIT_ONE_FIELD(), DIALOG_TEXT_PROPERTIES::DIALOG_TEXT_PROPERTIES(), DIALOG_ERC::DisplayERC_MarkersList(), ALIGN_DISTRIBUTE_TOOL::doAlignLeft(), ALIGN_DISTRIBUTE_TOOL::doAlignRight(), ALIGN_DISTRIBUTE_TOOL::doDistributeCentersHorizontally(), ALIGN_DISTRIBUTE_TOOL::doDistributeCentersVertically(), ALIGN_DISTRIBUTE_TOOL::doDistributeGapsHorizontally(), ALIGN_DISTRIBUTE_TOOL::doDistributeGapsVertically(), DRC::doTrackDrc(), KIGFX::SCH_PAINTER::draw(), KIGFX::GERBVIEW_PAINTER::Draw(), KIGFX::PCB_PAINTER::Draw(), KIGFX::PCB_PAINTER::draw(), CN_ITEM::Dump(), SCH_ITEM::Duplicate(), BOARD::Duplicate(), MODULE::Duplicate(), SCH_EDIT_TOOL::EditField(), LIB_EDIT_TOOL::editTextProperties(), EditToolSelectionFilter(), CONNECTION_GRAPH::ercCheckLabels(), 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(), SCH_LEGACY_PLUGIN::Format(), PCB_IO::Format(), PCB_IO::format(), FormatProbeItem(), POINT_EDITOR::get45DegConstrainer(), CN_ITEM::GetAnchor(), BOARD_ITEM::GetBoard(), TRACK::GetBoundingBox(), KIGFX::GERBVIEW_RENDER_SETTINGS::GetColor(), KIGFX::PCB_RENDER_SETTINGS::GetColor(), NETLIST_OBJECT::GetComponentParent(), SCH_MOVE_TOOL::getConnectedDragItems(), SCH_TEXT::GetConnectionPoints(), CONNECTION_SUBGRAPH::GetDriverPriority(), SCH_TEXT::GetEndPoints(), SCH_SHEET::GetEndPoints(), SCH_SCREEN::GetHierarchicalItems(), PL_EDITOR_FRAME::GetLayoutFromRedoList(), PL_EDITOR_FRAME::GetLayoutFromUndoList(), SCH_SCREENS::GetLibNicknames(), TEXTE_PCB::GetMsgPanelInfo(), SCH_TEXT::GetMsgPanelInfo(), CONNECTION_SUBGRAPH::GetNameForDriver(), CONNECTIVITY_DATA::GetNetItems(), LIB_PART::GetNextDrawItem(), DRAWSEGMENT::GetParentModule(), SCH_SCREEN::GetPin(), LIB_PART::GetPin(), SCH_COMPONENT::GetPinPhysicalPosition(), getRect(), KIGFX::SCH_PAINTER::getRenderColor(), PCBNEW_SELECTION::GetTopLeftItem(), EE_SELECTION_TOOL::GuessSelectionCandidates(), SELECTION_TOOL::guessSelectionCandidates(), hash_eda(), SCH_SCREENS::HasNoFullyDefinedLibIds(), SCH_SHEET::HasUndefinedPins(), EE_SELECTION_TOOL::highlight(), SELECTION_TOOL::highlight(), KIGFX::SCH_VIEW::HighlightItem(), SCH_EDIT_TOOL::Init(), ROUTER_TOOL::InlineBreakTrack(), ROUTER_TOOL::InlineDrag(), EE_COLLECTOR::Inspect(), GENERAL_COLLECTOR::Inspect(), PCB_LAYER_COLLECTOR::Inspect(), ARRAY_CREATOR::Invoke(), isNewSegment(), TRACK::IsNull(), SCH_LINE::IsParallel(), SCH_SCREEN::IsTerminalPoint(), BOARD_ITEM::IsTrack(), itemIsIncludedByFilter(), CLIPBOARD_IO::Load(), PNS_PCBNEW_RULE_RESOLVER::localPadClearance(), SCH_SHEET::LocatePathOfScreen(), SCH_MOVE_TOOL::Main(), EE_POINT_EDITOR::Main(), LIB_MOVE_TOOL::Main(), EE_SELECTION_TOOL::Main(), EDIT_POINTS_FACTORY::Make(), SCH_SCREEN::MarkConnections(), CN_CONNECTIVITY_ALGO::markItemNetAsDirty(), CONNECTIVITY_DATA::MarkItemNetAsDirty(), SCH_LINE::MergeOverlap(), SCH_EDIT_TOOL::Mirror(), SCH_MOVE_TOOL::moveItem(), SCH_CONNECTION::Name(), nextMatch(), FOOTPRINT_EDIT_FRAME::OnEditItemRequest(), PCB_EDIT_FRAME::OnEditItemRequest(), POINT_EDITOR::OnSelectionChange(), SCH_LINE::operator<(), LIB_ITEM::operator<(), SCH_ITEM::operator<(), SCH_COMPONENT::operator<(), SCH_BITMAP::operator=(), SCH_SHEET::operator=(), SCH_COMPONENT::operator=(), LIB_ITEM::operator==(), EDIT_TOOL::PadFilter(), BOARD_COMMIT::parentObject(), PCBNEW_CONTROL::Paste(), SCH_EDITOR_CONTROL::Paste(), DRAWING_TOOL::PlaceImportedGraphics(), SCH_FIELD::Plot(), BRDITEMS_PLOTTER::Plot_1_EdgeModule(), DIALOG_GLOBAL_EDIT_TRACKS_AND_VIAS::processItem(), LIB_EDIT_TOOL::Properties(), SCH_EDIT_TOOL::Properties(), BOARD_COMMIT::Push(), PCB_BASE_EDIT_FRAME::PutDataInPreviousState(), SELECTION_TOOL::RebuildSelection(), SCH_BASE_FRAME::RefreshItem(), DIALOG_SYMBOL_REMAP::remapSymbolsToLibTable(), MODULE::Remove(), CN_CONNECTIVITY_ALGO::Remove(), BOARD::Remove(), POINT_EDITOR::removeCorner(), POINT_EDITOR::removeCornerCondition(), LIB_PART::RemoveDrawItem(), SCH_SHEET::RemovePin(), SCH_EDIT_TOOL::RepeatDrawItem(), SCH_SCREENS::ReplaceDuplicateTimeStamps(), SCH_SCREEN::ReplaceWires(), CONNECTION_SUBGRAPH::ResolveDrivers(), WS_PROXY_UNDO_ITEM::Restore(), PL_EDITOR_FRAME::RollbackFromUndo(), SCH_EDIT_TOOL::Rotate(), SCH_TEXT::Rotate(), SCH_LEGACY_PLUGIN_CACHE::saveArc(), SCH_LEGACY_PLUGIN_CACHE::saveBezier(), SCH_LEGACY_PLUGIN_CACHE::saveCircle(), PCB_BASE_EDIT_FRAME::SaveCopyInUndoList(), EE_TOOL_BASE< SCH_BASE_FRAME >::saveCopyInUndoList(), SCH_LEGACY_PLUGIN_CACHE::saveField(), SCH_LEGACY_PLUGIN_CACHE::savePin(), SCH_LEGACY_PLUGIN_CACHE::savePolyLine(), SCH_LEGACY_PLUGIN_CACHE::saveRectangle(), SCH_LEGACY_PLUGIN_CACHE::saveText(), SCH_EDIT_FRAME::SaveUndoItemInUndoList(), SCH_EDIT_FRAME::SchematicCleanUp(), SCH_SHEET::SearchHierarchy(), SELECTION_TOOL::select(), EE_SELECTION_TOOL::selectable(), SELECTION_TOOL::selectable(), ITEM_PICKER::SetItem(), DIALOG_LABEL_EDITOR::SetTitle(), PCB_EDIT_FRAME::SetTrackSegmentWidth(), ShowClearance(), SortByTimeStamp(), SCH_JUNCTION::SwapData(), SCH_NO_CONNECT::SwapData(), SCH_BITMAP::SwapData(), PCB_TARGET::SwapData(), SCH_SHEET_PIN::SwapData(), TEXTE_PCB::SwapData(), SCH_FIELD::SwapData(), TRACK::SwapData(), SwapData(), DRAWSEGMENT::SwapData(), VIA::SwapData(), SCH_SHEET::SwapData(), SCH_COMPONENT::SwapData(), MODULE::SwapData(), ZONE_CONTAINER::SwapData(), D_PAD::SwapData(), SwapItemData(), TestDuplicateSheetNames(), TEXTE_MODULE::TEXTE_MODULE(), AR_MATRIX::TraceSegmentPcb(), DIALOG_LABEL_EDITOR::TransferDataFromWindow(), DIALOG_TEXT_PROPERTIES::TransferDataToWindow(), DIALOG_LABEL_EDITOR::TransferDataToWindow(), TRACK::TransformShapeWithClearanceToPolygon(), LIB_DRAWING_TOOLS::TwoClickPlace(), EE_SELECTION_TOOL::unhighlight(), SELECTION_TOOL::unhighlight(), SCH_SHEET_PATH::UpdateAllScreenReferences(), SCH_TEXT::UpdateDanglingState(), EE_POINT_EDITOR::updateItem(), PL_POINT_EDITOR::updateItem(), POINT_EDITOR::updateItem(), EE_POINT_EDITOR::updatePoints(), PL_POINT_EDITOR::updatePoints(), POINT_EDITOR::updatePoints(), EE_TOOL_BASE< SCH_BASE_FRAME >::updateView(), PCB_BRIGHT_BOX::ViewDraw(), SCH_BUS_ENTRY_BASE::ViewGetLayers(), TRACK::Visit(), GERBER_DRAW_ITEM::Visit(), SCH_SHEET::Visit(), SCH_COMPONENT::Visit(), and DIALOG_GLOBAL_EDIT_TEXT_AND_GRAPHICS::visitItem().

◆ UnLink()

void BOARD_ITEM::UnLink ( )
virtualinherited

Function UnLink detaches this object from its owner.

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

Definition at line 54 of file class_board_item.cpp.

55 {
57  wxASSERT( list );
58 
59  if( list )
60  list->Remove( this );
61 }
DHEAD * GetList() const
Definition: base_struct.h:208
T * Remove(T *aElement)
Function Remove removes aElement from the list, but does not delete it.
Definition: dlist.h:211
Class DLIST is the head of a doubly linked list.
Definition: dlist.h:142

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

◆ UpdateHeight()

void DIMENSION::UpdateHeight ( )

Function UpdateHeight Updates stored height basing on points coordinates.

Definition at line 218 of file class_dimension.cpp.

219 {
220  VECTOR2D featureLine( m_crossBarO - m_featureLineGO );
222 
223  if( featureLine.Cross( crossBar ) > 0 )
224  m_Height = -featureLine.EuclideanNorm();
225  else
226  m_Height = featureLine.EuclideanNorm();
227 }
int m_Height
length of feature lines
wxPoint m_featureLineGO
wxPoint m_crossBarO
wxPoint m_featureLineDO

References VECTOR2< T >::Cross(), VECTOR2< T >::EuclideanNorm(), m_crossBarO, m_featureLineDO, m_featureLineGO, and m_Height.

◆ ViewBBox()

const BOX2I DIMENSION::ViewBBox ( ) const
overridevirtual

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

Returns
BOX2I - the current bounding box

Reimplemented from EDA_ITEM.

Definition at line 498 of file class_dimension.cpp.

499 {
500  BOX2I dimBBox = BOX2I( VECTOR2I( GetBoundingBox().GetPosition() ),
501  VECTOR2I( GetBoundingBox().GetSize() ) );
502  dimBBox.Merge( m_Text.ViewBBox() );
503 
504  return dimBBox;
505 }
BOX2< VECTOR2I > BOX2I
Definition: box2.h:520
TEXTE_PCB m_Text
VECTOR2< int > VECTOR2I
Definition: vector2d.h:587
const EDA_RECT GetBoundingBox() const override
Function GetBoundingBox returns the orthogonal, bounding box of this object for display purposes.
BOX2< Vec > & Merge(const BOX2< Vec > &aRect)
Function Merge modifies the position and size of the rectangle in order to contain aRect.
Definition: box2.h:384
const wxPoint GetPosition() const override
virtual const BOX2I ViewBBox() const override
Function ViewBBox() returns the bounding box of the item covering all its layers.

References GetBoundingBox(), GetPosition(), m_Text, BOX2< Vec >::Merge(), and EDA_ITEM::ViewBBox().

◆ ViewDraw()

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

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

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

Parameters
aLayercurrent drawing layer
aViewpointer to the VIEW device we are drawing on

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

Definition at line 116 of file view_item.h.

117  {}

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

◆ ViewGetLayers()

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

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

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

Parameters
aLayers[]output layer index array
aCountnumber of layer indices in aLayers[]

Reimplemented from EDA_ITEM.

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

Definition at line 90 of file class_board_item.cpp.

91 {
92  // Basic fallback
93  aCount = 1;
94  aLayers[0] = m_Layer;
95 }
PCB_LAYER_ID m_Layer

References BOARD_ITEM::m_Layer.

Referenced by SELECTION_TOOL::selectable().

◆ ViewGetLOD()

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

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

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

Parameters
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 in D_PAD, MODULE, VIA, GERBER_DRAW_ITEM, TRACK, TEXTE_MODULE, and EDGE_MODULE.

Definition at line 140 of file view_item.h.

141  {
142  // By default always show the item
143  return 0;
144  }

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

◆ viewPrivData()

◆ Visit()

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

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

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

Parameters
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 in BOARD, LIB_PART, SCH_COMPONENT, MODULE, SCH_SHEET, GERBER_FILE_IMAGE, GERBER_DRAW_ITEM, TRACK, and GBR_LAYOUT.

Definition at line 135 of file base_struct.cpp.

136 {
137 #if 0 && defined(DEBUG)
138  std::cout << GetClass().mb_str() << ' ';
139 #endif
140 
141  if( IsType( scanTypes ) )
142  {
143  if( SEARCH_QUIT == inspector( this, testData ) )
144  return SEARCH_QUIT;
145  }
146 
147  return SEARCH_CONTINUE;
148 }
virtual bool IsType(const KICAD_T aScanTypes[])
Function IsType Checks whether the item is one of the listed types.
Definition: base_struct.h:280
virtual wxString GetClass() const =0
Function GetClass returns the class name.

References EDA_ITEM::GetClass(), EDA_ITEM::IsType(), SEARCH_CONTINUE, and SEARCH_QUIT.

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

Member Data Documentation

◆ m_arrowD1F

◆ m_arrowD2F

◆ m_arrowG1F

◆ m_arrowG2F

◆ m_crossBarF

◆ m_crossBarO

◆ m_featureLineDF

◆ m_featureLineDO

◆ m_featureLineGF

◆ m_featureLineGO

◆ m_Flags

◆ m_forceVisible

bool EDA_ITEM::m_forceVisible
protectedinherited

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

Definition at line 171 of file base_struct.h.

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

◆ m_Height

int DIMENSION::m_Height
private

length of feature lines

Definition at line 68 of file class_dimension.h.

Referenced by AdjustDimensionDetails(), GetHeight(), SetHeight(), and UpdateHeight().

◆ m_Layer

◆ m_List

DHEAD* EDA_ITEM::m_List
protectedinherited

which DLIST I am on.

Definition at line 165 of file base_struct.h.

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

◆ m_Parent

◆ m_Shape

int DIMENSION::m_Shape
private

Currently always 0.

Definition at line 64 of file class_dimension.h.

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

◆ m_Text

◆ m_TimeStamp

timestamp_t EDA_ITEM::m_TimeStamp
protectedinherited

◆ m_Unit

EDA_UNITS_T DIMENSION::m_Unit
private

0 = inches, 1 = mm

Definition at line 65 of file class_dimension.h.

Referenced by AdjustDimensionDetails(), GetUnits(), and SetUnits().

◆ m_UseMils

bool DIMENSION::m_UseMils
private

If inches, use mils.

Definition at line 66 of file class_dimension.h.

Referenced by AdjustDimensionDetails(), GetUnits(), and SetUnits().

◆ m_Value

int DIMENSION::m_Value
private

value of PCB dimensions.

Definition at line 67 of file class_dimension.h.

Referenced by AdjustDimensionDetails(), GetValue(), and SetValue().

◆ m_Width

int DIMENSION::m_Width
private

Line width.

Definition at line 63 of file class_dimension.h.

Referenced by AdjustDimensionDetails(), GetWidth(), HitTest(), Print(), and SetWidth().

◆ Pback

EDA_ITEM* EDA_ITEM::Pback
protectedinherited

◆ Pnext

◆ ZeroOffset

wxPoint BOARD_ITEM::ZeroOffset
staticinherited

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

Definition at line 115 of file class_board_item.h.

Referenced by BOARD::GetPosition().


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