KiCad PCB EDA Suite
DIMENSION Class Reference

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, int aPrecision)
 Function SetOrigin Sets a new origin of the crossbar line. More...
 
const wxPointGetOrigin () const
 Function GetOrigin. More...
 
void SetEnd (const wxPoint &aEnd, int aPrecision)
 Function SetEnd Sets a new end of the crossbar line. More...
 
const wxPointGetEnd ()
 Function GetEnd. More...
 
void SetHeight (int aHeight, int aPrecision)
 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 (int aPrecision)
 Function AdjustDimensionDetails Calculate coordinates of segments used to draw the dimension. More...
 
void GetUnits (EDA_UNITS &aUnits, bool &aUseMils) const
 
void SetUnits (EDA_UNITS 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 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 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...
 
virtual bool IsOnCopperLayer () const
 
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...
 
void DeleteStructure ()
 Function DeleteStructure deletes this object after removing from its parent 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
 
void SetParent (EDA_ITEM *aParent)
 
bool IsNew () const
 
bool IsModified () const
 
bool IsMoving () const
 
bool IsDragging () const
 
bool IsWireImage () const
 
bool IsSelected () const
 
bool IsResized () const
 
bool IsHighlighted () const
 
bool IsBrightened () const
 
void SetWireImage ()
 
void SetSelected ()
 
void SetHighlighted ()
 
void SetBrightened ()
 
void ClearSelected ()
 
void ClearHighlighted ()
 
void ClearBrightened ()
 
void SetModified ()
 
int GetState (int type) const
 
void SetState (int type, int state)
 
STATUS_FLAGS GetStatus () const
 
void SetStatus (STATUS_FLAGS aStatus)
 
void SetFlags (STATUS_FLAGS aMask)
 
void ClearFlags (STATUS_FLAGS aMask=EDA_ITEM_ALL_FLAGS)
 
STATUS_FLAGS GetFlags () const
 
bool HasFlag (STATUS_FLAGS aFlag)
 
STATUS_FLAGS GetEditFlags () const
 
void ClearTempFlags ()
 
void ClearEditFlags ()
 
virtual bool IsType (const KICAD_T aScanTypes[]) const
 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...
 
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...
 
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...
 
template<class T >
static SEARCH_RESULT IterateForward (std::vector< T > &aList, INSPECTOR inspector, void *testData, const KICAD_T scanTypes[])
 IterateForward( EDA_ITEM*, INSPECTOR, void*, const KICAD_T ) More...
 
static 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...
 
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_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 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

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

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

References Dwgs_User, BOARD_ITEM::m_Layer, and m_Shape.

Referenced by Clone().

◆ ~DIMENSION()

DIMENSION::~DIMENSION ( )

Definition at line 57 of file class_dimension.cpp.

58 {
59 }

Member Function Documentation

◆ AdjustDimensionDetails()

void DIMENSION::AdjustDimensionDetails ( int  aPrecision)

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

Parameters
aPrecisionnumber of decimal places for mils (scaled appropriately for other units).

Definition at line 231 of file class_dimension.cpp.

232 {
233  const int arrowz = Mils2iu( 50 ); // size of arrows
234  int ii;
235  int measure, deltax, deltay; // value of the measure on X and Y axes
236  int arrow_up_X = 0, arrow_up_Y = 0; // coordinates of arrow line /
237  int arrow_dw_X = 0, arrow_dw_Y = 0; // coordinates of arrow line '\'
238  int hx, hy; // dimension line interval
239  double angle, angle_f;
240 
241  // Init layer :
242  m_Text.SetLayer( GetLayer() );
243 
244  // calculate the size of the dimension (text + line above the text)
246 
247  deltax = m_featureLineDO.x - m_featureLineGO.x;
248  deltay = m_featureLineDO.y - m_featureLineGO.y;
249 
250  // Calculate dimension value
251  measure = KiROUND( hypot( deltax, deltay ) );
252 
253  angle = atan2( (double)deltay, (double)deltax );
254 
255  // Calculation of parameters X and Y dimensions of the arrows and lines.
256  hx = hy = ii;
257 
258  // Taking into account the slope of the side lines.
259  if( measure )
260  {
261  hx = abs( KiROUND( ( (double) deltay * hx ) / measure ) );
262  hy = abs( KiROUND( ( (double) deltax * hy ) / measure ) );
263 
265  hx = -hx;
266 
267  if( m_featureLineGO.x == m_crossBarO.x )
268  hx = 0;
269 
271  hy = -hy;
272 
273  if( m_featureLineGO.y == m_crossBarO.y )
274  hy = 0;
275 
276  angle_f = angle + DEG2RAD( 27.5 );
277  arrow_up_X = wxRound( arrowz * cos( angle_f ) );
278  arrow_up_Y = wxRound( arrowz * sin( angle_f ) );
279  angle_f = angle - DEG2RAD( 27.5 );
280  arrow_dw_X = wxRound( arrowz * cos( angle_f ) );
281  arrow_dw_Y = wxRound( arrowz * sin( angle_f ) );
282  }
283 
284  int dx = KiROUND( m_Height * cos( angle + M_PI / 2 ) );
285  int dy = KiROUND( m_Height * sin( angle + M_PI / 2 ) );
290 
291  m_arrowG1F.x = m_crossBarO.x + arrow_up_X;
292  m_arrowG1F.y = m_crossBarO.y + arrow_up_Y;
293 
294  m_arrowG2F.x = m_crossBarO.x + arrow_dw_X;
295  m_arrowG2F.y = m_crossBarO.y + arrow_dw_Y;
296 
297  /* The right arrow is symmetrical to the left.
298  * / = -\ and \ = -/
299  */
300  m_arrowD1F.x = m_crossBarF.x - arrow_dw_X;
301  m_arrowD1F.y = m_crossBarF.y - arrow_dw_Y;
302 
303  m_arrowD2F.x = m_crossBarF.x - arrow_up_X;
304  m_arrowD2F.y = m_crossBarF.y - arrow_up_Y;
305 
306  // Length of feature lines
307  double radius = ( m_Height +
308  ( std::copysign( 1.0, m_Height ) *
309  arrowz * sin( DEG2RAD( 27.5 ) ) ) );
310 
311  m_featureLineGF.x = m_featureLineGO.x - wxRound( radius * sin( angle ) );
312  m_featureLineGF.y = m_featureLineGO.y + wxRound( radius * cos( angle ) );
313 
314  m_featureLineDF.x = m_featureLineDO.x - wxRound( radius * sin( angle ) );
315  m_featureLineDF.y = m_featureLineDO.y + wxRound( radius * cos( angle ) );
316 
317  // Calculate the better text position and orientation:
318  radius = ( std::copysign( 1.0, m_Height ) * ii );
319 
320  wxPoint textPos;
321  textPos.x = ( m_crossBarF.x + m_crossBarO.x ) / 2;
322  textPos.y = ( m_crossBarF.y + m_crossBarO.y ) / 2;
323 
324  textPos.x -= KiROUND( radius * sin( angle ) );
325  textPos.y += KiROUND( radius * cos( angle ) );
326 
327  m_Text.SetTextPos( textPos );
328 
329  double newAngle = -RAD2DECIDEG( angle );
330 
331  NORMALIZE_ANGLE_POS( newAngle );
332 
333  if( newAngle > 900 && newAngle < 2700 )
334  newAngle -= 1800;
335 
336  m_Text.SetTextAngle( newAngle );
337 
338  m_Value = measure;
339 
341  aPrecision += 2;
342  else if( !m_UseMils )
343  aPrecision += 3;
344 
345  wxString text;
346  wxString format = wxT( "%." ) + wxString::Format( "%i", aPrecision ) + wxT( "f" );
347 
348  text.Printf( format, To_User_Unit( m_Unit, m_Value, m_UseMils ) );
349  text += " ";
351 
352  SetText( text );
353 }
double To_User_Unit(EDA_UNITS aUnit, double aValue, bool aUseMils)
Function To_User_Unit convert aValue in internal units to the appropriate user units defined by aUnit...
Definition: base_units.cpp:95
void SetTextAngle(double aAngle)
void SetText(const wxString &NewText)
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:231
double RAD2DECIDEG(double rad)
Definition: trigo.h:215
TEXTE_PCB m_Text
int GetThickness() const
Return the pen width.
Definition: eda_text.h:148
wxPoint m_featureLineDF
void NORMALIZE_ANGLE_POS(T &Angle)
Definition: trigo.h:252
wxString GetAbbreviatedUnitsLabel(EDA_UNITS aUnit, bool aUseMils)
Get the units string for a given units type.
Definition: base_units.cpp:452
int GetTextHeight() const
Definition: eda_text.h:229
wxPoint m_featureLineGO
bool m_UseMils
If inches, use mils.
wxPoint m_arrowG1F
wxPoint m_arrowD2F
wxPoint m_arrowG2F
int m_Width
Line width.
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
double DEG2RAD(double deg)
Definition: trigo.h:210
static DIRECTION_45::AngleType angle(const VECTOR2I &a, const VECTOR2I &b)
constexpr ret_type KiROUND(fp_type v)
Round a floating point number to an integer using "round halfway cases away from zero".
Definition: util.h:61
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.
EDA_UNITS m_Unit
0 = inches, 1 = mm
wxPoint m_featureLineGF

References PNS::angle(), DEG2RAD(), Format(), GetAbbreviatedUnitsLabel(), 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, MILLIMETRES, NORMALIZE_ANGLE_POS(), RAD2DECIDEG(), BOARD_ITEM::SetLayer(), SetText(), TEXTE_PCB::SetTextAngle(), EDA_TEXT::SetTextPos(), To_User_Unit(), wxPoint::x, and wxPoint::y.

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

◆ 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:99
KICAD_T Type() const
Function Type()
Definition: base_struct.h:207

References PCB_DIMENSION_T, and EDA_ITEM::Type().

◆ ClearBrightened()

void EDA_ITEM::ClearBrightened ( )
inlineinherited

Definition at line 235 of file base_struct.h.

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

References BRIGHTENED, and EDA_ITEM::ClearFlags().

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

◆ ClearEditFlags()

◆ ClearFlags()

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

Definition at line 256 of file base_struct.h.

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

References EDA_ITEM::m_Flags.

Referenced by FOOTPRINT_VIEWER_FRAME::AddFootprintToPCB(), PNS_KICAD_IFACE::AddItem(), SCH_EDIT_FRAME::AddItemToScreenAndUndoList(), SCH_COMPONENT::ClearAllHighlightFlags(), 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(), 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 234 of file base_struct.h.

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

References EDA_ITEM::ClearFlags(), and HIGHLIGHTED.

◆ ClearSelected()

void EDA_ITEM::ClearSelected ( )
inlineinherited

◆ ClearTempFlags()

void EDA_ITEM::ClearTempFlags ( )
inlineinherited

Definition at line 268 of file base_struct.h.

269  {
271  }
#define IS_LINKED
Used in calculation to mark linked items (temporary use)
Definition: base_struct.h:117
#define SKIP_STRUCT
flag indicating that the structure should be ignored
Definition: base_struct.h:131
#define CANDIDATE
flag indicating that the structure is connected
Definition: base_struct.h:130
#define ENDPOINT
ends. (Used to support dragging.)
Definition: base_struct.h:126
void ClearFlags(STATUS_FLAGS aMask=EDA_ITEM_ALL_FLAGS)
Definition: base_struct.h:256
#define DO_NOT_DRAW
Used to disable draw function.
Definition: base_struct.h:132
#define STARTPOINT
When a line is selected, these flags indicate which.
Definition: base_struct.h:125

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  {
156  }
VIEW_ITEM_DATA * m_viewPrivData
Definition: view_item.h:161
#define NULL

References KIGFX::VIEW_ITEM::m_viewPrivData, and NULL.

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

523 {
524  return new DIMENSION( *this );
525 }
DIMENSION(BOARD_ITEM *aParent)

References DIMENSION().

◆ DeleteStructure()

void BOARD_ITEM::DeleteStructure ( )
inherited

Function DeleteStructure deletes this object after removing from its parent if it has one.

Definition at line 117 of file class_board_item.cpp.

118 {
119  auto parent = GetParent();
120 
121  if( parent )
122  parent->Remove( this );
123 
124  delete this;
125 }
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 139 of file class_dimension.cpp.

140 {
141  Mirror( aCentre );
142 
143  // DIMENSION items are not usually on copper layers, so
144  // copper layers count is not taken in accoun in Flip transform
145  SetLayer( FlipLayer( GetLayer() ) );
146 }
PCB_LAYER_ID FlipLayer(PCB_LAYER_ID aLayerId, int aCopperLayersCount)
Function FlippedLayerNumber.
Definition: lset.cpp:485
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 269 of file class_board_item.h.

270  {
271  Flip( wxPoint( aCentre.x, aCentre.y ), aFlipLeftRight );
272  }
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 174 of file class_dimension.h.

175  {
177 
178  return atan2( (double)delta.y, (double)delta.x );
179  }
wxPoint m_featureLineGO
wxPoint m_featureLineDO

References m_featureLineDO, m_featureLineGO, wxPoint::x, and wxPoint::y.

◆ GetBoard()

BOARD * BOARD_ITEM::GetBoard ( ) const
virtualinherited

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

Definition at line 54 of file class_board_item.cpp.

55 {
56  if( Type() == PCB_T )
57  return (BOARD*) this;
58 
59  BOARD_ITEM* parent = GetParent();
60 
61  if( parent )
62  return parent->GetBoard();
63 
64  return NULL;
65 }
Definition: typeinfo.h:85
BOARD_ITEM is a base class for any item which can be embedded within the BOARD container class,...
#define NULL
virtual BOARD * GetBoard() const
Function GetBoard returns the BOARD in which this BOARD_ITEM resides, or NULL if none.
BOARD holds information pertinent to a Pcbnew printed circuit board.
Definition: class_board.h:160
BOARD_ITEM_CONTAINER * GetParent() const
KICAD_T Type() const
Function Type()
Definition: base_struct.h:207

References BOARD_ITEM::GetBoard(), BOARD_ITEM::GetParent(), NULL, 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 451 of file class_dimension.cpp.

452 {
453  EDA_RECT bBox;
454  int xmin, xmax, ymin, ymax;
455 
456  bBox = m_Text.GetTextBox( -1 );
457  xmin = bBox.GetX();
458  xmax = bBox.GetRight();
459  ymin = bBox.GetY();
460  ymax = bBox.GetBottom();
461 
462  xmin = std::min( xmin, m_crossBarO.x );
463  xmin = std::min( xmin, m_crossBarF.x );
464  ymin = std::min( ymin, m_crossBarO.y );
465  ymin = std::min( ymin, m_crossBarF.y );
466  xmax = std::max( xmax, m_crossBarO.x );
467  xmax = std::max( xmax, m_crossBarF.x );
468  ymax = std::max( ymax, m_crossBarO.y );
469  ymax = std::max( ymax, m_crossBarF.y );
470 
471  xmin = std::min( xmin, m_featureLineGO.x );
472  xmin = std::min( xmin, m_featureLineGF.x );
473  ymin = std::min( ymin, m_featureLineGO.y );
474  ymin = std::min( ymin, m_featureLineGF.y );
475  xmax = std::max( xmax, m_featureLineGO.x );
476  xmax = std::max( xmax, m_featureLineGF.x );
477  ymax = std::max( ymax, m_featureLineGO.y );
478  ymax = std::max( ymax, m_featureLineGF.y );
479 
480  xmin = std::min( xmin, m_featureLineDO.x );
481  xmin = std::min( xmin, m_featureLineDF.x );
482  ymin = std::min( ymin, m_featureLineDO.y );
483  ymin = std::min( ymin, m_featureLineDF.y );
484  xmax = std::max( xmax, m_featureLineDO.x );
485  xmax = std::max( xmax, m_featureLineDF.x );
486  ymax = std::max( ymax, m_featureLineDO.y );
487  ymax = std::max( ymax, m_featureLineDF.y );
488 
489  bBox.SetX( xmin );
490  bBox.SetY( ymin );
491  bBox.SetWidth( xmax - xmin + 1 );
492  bBox.SetHeight( ymax - ymin + 1 );
493 
494  bBox.Normalize();
495 
496  return bBox;
497 }
wxPoint m_crossBarF
int GetX() const
Definition: eda_rect.h:111
TEXTE_PCB m_Text
wxPoint m_featureLineDF
int GetBottom() const
Definition: eda_rect.h:124
wxPoint m_featureLineGO
void SetHeight(int val)
Definition: eda_rect.h:186
EDA_RECT GetTextBox(int aLine=-1, int aThickness=-1, bool aInvertY=false, int aMarkupFlags=0) const
Useful in multiline texts to calculate the full text or a line area (for zones filling,...
Definition: eda_text.cpp:184
int GetRight() const
Definition: eda_rect.h:121
void SetX(int val)
Definition: eda_rect.h:168
void SetWidth(int val)
Definition: eda_rect.h:180
void SetY(int val)
Definition: eda_rect.h:174
void Normalize()
Function Normalize ensures that the height ant width are positive.
EDA_RECT handles the component boundary box.
Definition: eda_rect.h:44
int GetY() const
Definition: eda_rect.h:112
wxPoint m_crossBarO
wxPoint m_featureLineDO
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, EDA_RECT::Normalize(), EDA_RECT::SetHeight(), EDA_RECT::SetWidth(), EDA_RECT::SetX(), EDA_RECT::SetY(), wxPoint::x, and wxPoint::y.

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

Referenced by ALIGN_DISTRIBUTE_TOOL::doDistributeCentersHorizontally(), and ALIGN_DISTRIBUTE_TOOL::doDistributeCentersVertically().

◆ GetClass()

wxString DIMENSION::GetClass ( ) const
inlineoverridevirtual

Function GetClass returns the class name.

Returns
wxString

Implements EDA_ITEM.

Definition at line 230 of file class_dimension.h.

231  {
232  return wxT( "DIMENSION" );
233  }

◆ GetEditFlags()

STATUS_FLAGS EDA_ITEM::GetEditFlags ( ) const
inlineinherited

Definition at line 260 of file base_struct.h.

261  {
265  return m_Flags & mask;
266  }
#define TEMP_SELECTED
flag indicating that the structure has already selected
Definition: base_struct.h:128
#define END_ONPAD
Pcbnew: flag set for track segment ending on a pad.
Definition: base_struct.h:139
#define BEGIN_ONPAD
Pcbnew: flag set for track segment starting on a pad.
Definition: base_struct.h:138
#define EDA_ITEM_ALL_FLAGS
Definition: base_struct.h:154
#define SELECTED
Definition: base_struct.h:127
#define BRIGHTENED
item is drawn with a bright contour
Definition: base_struct.h:143
#define DP_COUPLED
item is coupled with another item making a differential pair
Definition: base_struct.h:145
#define HIGHLIGHTED
item is drawn in normal colors, when the rest is darkened
Definition: base_struct.h:142
#define IS_DANGLING
indicates a pin is dangling
Definition: base_struct.h:149
STATUS_FLAGS m_Flags
Flag bits for editing and other uses.
Definition: base_struct.h:184
#define ENDPOINT
ends. (Used to support dragging.)
Definition: base_struct.h:126
#define STARTPOINT
When a line is selected, these flags indicate which.
Definition: base_struct.h:125

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

Referenced by SCH_EDIT_TOOL::ChangeShape(), EDA_ITEM::ClearEditFlags(), SCH_EDIT_FRAME::ConvertTextType(), SCH_EDIT_FRAME::DeleteJunction(), SCH_EDIT_TOOL::editComponentFieldText(), SCH_EDITOR_CONTROL::EditWithLibEdit(), LIB_MOVE_TOOL::Main(), POINT_EDITOR::OnSelectionChange(), 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(), DIALOG_FOOTPRINT_BOARD_EDITOR::TransferDataFromWindow(), and SCH_EDIT_FRAME::TrimWire().

◆ GetEnd()

const wxPoint& DIMENSION::GetEnd ( )
inline

Function GetEnd.

Returns
End of the crossbar line.

Definition at line 141 of file class_dimension.h.

142  {
143  return m_featureLineDO;
144  }
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 158 of file class_dimension.h.

159  {
160  return m_Height;
161  }
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 131 of file class_board_item.h.

131 { return m_Layer; }
PCB_LAYER_ID m_Layer

References BOARD_ITEM::m_Layer.

Referenced by 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(), BOARD_ITEM::IsOnCopperLayer(), 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(), TRACK::ViewGetLayers(), TEXTE_MODULE::ViewGetLayers(), TEXTE_MODULE::ViewGetLOD(), MODULE_ZONE_CONTAINER::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 68 of file class_board_item.cpp.

69 {
70  BOARD* board = GetBoard();
71 
72  if( board )
73  return board->GetLayerName( m_Layer );
74 
75  // If no parent, return standard name
77 }
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.
BOARD holds information pertinent to a Pcbnew printed circuit board.
Definition: class_board.h:160
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:646

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(), TRACK::GetSelectMenuText(), TEXTE_MODULE::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 139 of file class_board_item.h.

139 { return LSET( m_Layer ); }
PCB_LAYER_ID m_Layer
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().

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

507 {
508  return add_dimension_xpm;
509 }
const BITMAP_OPAQUE add_dimension_xpm[1]

References add_dimension_xpm.

◆ GetMsgPanelInfo()

void DIMENSION::GetMsgPanelInfo ( EDA_UNITS  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 394 of file class_dimension.cpp.

395 {
396  // for now, display only the text within the DIMENSION using class TEXTE_PCB.
397  m_Text.GetMsgPanelInfo( aUnits, aList );
398 }
TEXTE_PCB m_Text
void GetMsgPanelInfo(EDA_UNITS 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 88 of file class_board_item.cpp.

89 {
90  if( aSeq.empty() )
91  return 1;
92 
93  // By default go to the end of the sequence
94  int candidate = *aSeq.rbegin();
95 
96  // Filling in gaps in pad numbering
97  if( aFillSequenceGaps )
98  {
99  // start at the beginning
100  candidate = *aSeq.begin();
101 
102  for( auto it : aSeq )
103  {
104  if( it - candidate > 1 )
105  break;
106 
107  candidate = it;
108  }
109  }
110 
111  ++candidate;
112 
113  return candidate;
114 }

Referenced by MODULE::GetNextPadName().

◆ GetOrigin()

const wxPoint& DIMENSION::GetOrigin ( ) const
inline

Function GetOrigin.

Returns
Origin of the crossbar line.

Definition at line 124 of file class_dimension.h.

125  {
126  return m_featureLineGO;
127  }
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 125 of file class_board_item.h.

125 { return (BOARD_ITEM_CONTAINER*) m_Parent; }
EDA_ITEM * m_Parent
Linked list: Link (parent struct)
Definition: base_struct.h:177
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(), SELECTION_TOOL::Selectable(), SwapItemData(), DRC::testCopperDrawItem(), DIALOG_TEXT_PROPERTIES::TransferDataToWindow(), MODULE_ZONE_CONTAINER::ViewGetLOD(), and DIALOG_GLOBAL_EDIT_TEXT_AND_GRAPHICS::visitItem().

◆ GetPosition()

const wxPoint DIMENSION::GetPosition ( ) const
overridevirtual

Implements BOARD_ITEM.

Definition at line 68 of file class_dimension.cpp.

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

References EDA_TEXT::GetTextPos(), and m_Text.

Referenced by ViewBBox().

◆ GetSelectMenuText()

wxString DIMENSION::GetSelectMenuText ( EDA_UNITS  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 500 of file class_dimension.cpp.

501 {
502  return wxString::Format( _( "Dimension \"%s\" on %s" ), GetText(), GetLayerName() );
503 }
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
#define _(s)
Definition: 3d_actions.cpp:31
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 239 of file base_struct.h.

240  {
241  return m_Status & type;
242  }
STATUS_FLAGS m_Status
Definition: base_struct.h:173

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

252 { return m_Status; }
STATUS_FLAGS m_Status
Definition: base_struct.h:173

References EDA_ITEM::m_Status.

Referenced by PCB_IO::format().

◆ GetText()

const wxString DIMENSION::GetText ( ) const

Definition at line 80 of file class_dimension.cpp.

81 {
82  return m_Text.GetText();
83 }
TEXTE_PCB m_Text
virtual const wxString & GetText() const
Return the string associated with the text object.
Definition: eda_text.h:123

References EDA_TEXT::GetText(), and m_Text.

Referenced by GetSelectMenuText().

◆ GetTimeStamp()

◆ GetUnits()

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

Definition at line 188 of file class_dimension.h.

189  {
190  aUnits = m_Unit;
191  aUseMils = m_UseMils;
192  }
bool m_UseMils
If inches, use mils.
EDA_UNITS m_Unit
0 = inches, 1 = mm

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

◆ HasFlag()

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

402 {
403  if( m_Text.TextHitTest( aPosition ) )
404  return true;
405 
406  int dist_max = aAccuracy + ( m_Width / 2 );
407 
408  // Locate SEGMENTS
409 
410  if( TestSegmentHit( aPosition, m_crossBarO, m_crossBarF, dist_max ) )
411  return true;
412 
413  if( TestSegmentHit( aPosition, m_featureLineGO, m_featureLineGF, dist_max ) )
414  return true;
415 
416  if( TestSegmentHit( aPosition, m_featureLineDO, m_featureLineDF, dist_max ) )
417  return true;
418 
419  if( TestSegmentHit( aPosition, m_crossBarF, m_arrowD1F, dist_max ) )
420  return true;
421 
422  if( TestSegmentHit( aPosition, m_crossBarF, m_arrowD2F, dist_max ) )
423  return true;
424 
425  if( TestSegmentHit( aPosition, m_crossBarO, m_arrowG1F, dist_max ) )
426  return true;
427 
428  if( TestSegmentHit( aPosition, m_crossBarO, m_arrowG2F, dist_max ) )
429  return true;
430 
431  return false;
432 }
wxPoint m_crossBarF
wxPoint m_arrowD1F
TEXTE_PCB m_Text
wxPoint m_featureLineDF
bool TestSegmentHit(const wxPoint &aRefPoint, wxPoint aStart, wxPoint aEnd, int aDist)
Function TestSegmentHit test for hit on line segment i.e.
Definition: trigo.cpp:129
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
Test if aPoint is within the bounds of this object.
Definition: eda_text.cpp:336
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, 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 435 of file class_dimension.cpp.

436 {
437  EDA_RECT arect = aRect;
438  arect.Inflate( aAccuracy );
439 
440  EDA_RECT rect = GetBoundingBox();
441  if( aAccuracy )
442  rect.Inflate( aAccuracy );
443 
444  if( aContained )
445  return arect.Contains( rect );
446 
447  return arect.Intersects( rect );
448 }
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.
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 221 of file base_struct.h.

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

References IS_DRAGGED, and EDA_ITEM::m_Flags.

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

◆ IsHighlighted()

bool EDA_ITEM::IsHighlighted ( ) const
inlineinherited

Definition at line 225 of file base_struct.h.

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

References HIGHLIGHTED, and EDA_ITEM::m_Flags.

Referenced by SCH_COMPONENT::ClearAllHighlightFlags(), KIGFX::SCH_PAINTER::draw(), KIGFX::PCB_RENDER_SETTINGS::GetColor(), KIGFX::SCH_PAINTER::getRenderColor(), and KIGFX::SCH_VIEW::HighlightItem().

◆ 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 198 of file class_board_item.h.

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

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

◆ IsModified()

bool EDA_ITEM::IsModified ( ) const
inlineinherited

Definition at line 219 of file base_struct.h.

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

References IS_CHANGED, and EDA_ITEM::m_Flags.

Referenced by PCB_EDIT_FRAME::OpenProjectFiles().

◆ IsMoving()

◆ IsNew()

◆ IsOnCopperLayer()

virtual bool BOARD_ITEM::IsOnCopperLayer ( ) const
inlinevirtualinherited
Returns
true if the object is on any copper layer, false otherwise.

Reimplemented in D_PAD, TRACK, and ZONE_CONTAINER.

Definition at line 115 of file class_board_item.h.

116  {
117  return IsCopperLayer( GetLayer() );
118  }
bool IsCopperLayer(LAYER_NUM aLayerId)
Function IsCopperLayer tests whether a layer is a copper layer.
virtual PCB_LAYER_ID GetLayer() const
Function GetLayer returns the primary layer this item is on.

References BOARD_ITEM::GetLayer(), and IsCopperLayer().

Referenced by CN_CONNECTIVITY_ALGO::Add(), and BOARD_CONNECTED_ITEM::SetNetCode().

◆ 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 178 of file class_board_item.h.

179  {
180  return m_Layer == aLayer;
181  }
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_TEXT, SCH_FIELD, and SCH_SHEET_PIN.

Definition at line 515 of file base_struct.h.

515 { return false; }

Referenced by EDA_ITEM::Matches().

◆ IsResized()

bool EDA_ITEM::IsResized ( ) const
inlineinherited

Definition at line 224 of file base_struct.h.

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

References IS_RESIZED, and EDA_ITEM::m_Flags.

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

◆ 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 189 of file class_board_item.h.

190  {
191  return ( Type() == PCB_TRACE_T ) || ( Type() == PCB_VIA_T );
192  }
class TRACK, a track segment (segment on a copper layer)
Definition: typeinfo.h:96
class VIA, a via (like a track segment on a copper layer)
Definition: typeinfo.h:97
KICAD_T Type() const
Function Type()
Definition: base_struct.h:207

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

◆ IsType()

virtual bool EDA_ITEM::IsType ( const KICAD_T  aScanTypes[]) const
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 284 of file base_struct.h.

285  {
286  if( aScanTypes[0] == SCH_LOCATE_ANY_T )
287  return true;
288 
289  for( const KICAD_T* p = aScanTypes; *p != EOT; ++p )
290  {
291  if( m_StructType == *p )
292  return true;
293  }
294 
295  return false;
296  }
KICAD_T m_StructType
Run time identification, keep private so it can never be changed after a constructor sets it.
Definition: base_struct.h:172
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_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(), 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 222 of file base_struct.h.

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

References IS_WIRE_IMAGE, and EDA_ITEM::m_Flags.

◆ IterateForward() [1/2]

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

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

401  {
402  for( auto it : aList )
403  {
404  if( static_cast<EDA_ITEM*>( it )->Visit( inspector, testData, scanTypes )
406  return SEARCH_RESULT::QUIT;
407  }
408 
410  }
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 CONTINUE, QUIT, and EDA_ITEM::Visit().

Referenced by GERBER_FILE_IMAGE::Visit(), and BOARD::Visit().

◆ IterateForward() [2/2]

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

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 std::vector instead

Definition at line 418 of file base_struct.h.

420  {
421  for( auto it : aList )
422  {
423  if( static_cast<EDA_ITEM*>( it )->Visit( inspector, testData, scanTypes )
425  return SEARCH_RESULT::QUIT;
426  }
427 
429  }
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 CONTINUE, 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_TEXT, SCH_FIELD, SCH_SHEET_PIN, LIB_PIN, MARKER_PCB, SCH_PIN, SCH_MARKER, TEXTE_MODULE, and TEXTE_PCB.

Definition at line 471 of file base_struct.h.

472  {
473  return false;
474  }

Referenced by SCH_EDITOR_CONTROL::HasMatch(), TEXTE_PCB::Matches(), TEXTE_MODULE::Matches(), SCH_MARKER::Matches(), MARKER_PCB::Matches(), LIB_PIN::Matches(), SCH_SHEET_PIN::Matches(), SCH_FIELD::Matches(), SCH_TEXT::Matches(), SCH_SHEET::Matches(), and SCH_EDITOR_CONTROL::ReplaceAndFindNext().

◆ 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 153 of file base_struct.cpp.

154 {
155  wxString text = aText;
156  wxString searchText = aSearchData.GetFindString();
157 
158  // Don't match if searching for replaceable item and the item doesn't support text replace.
159  if( (aSearchData.GetFlags() & FR_SEARCH_REPLACE) && !IsReplaceable() )
160  return false;
161 
162  if( aSearchData.GetFlags() & wxFR_WHOLEWORD )
163  return aText.IsSameAs( searchText, aSearchData.GetFlags() & wxFR_MATCHCASE );
164 
165  if( aSearchData.GetFlags() & FR_MATCH_WILDCARD )
166  {
167  if( aSearchData.GetFlags() & wxFR_MATCHCASE )
168  return text.Matches( searchText );
169 
170  return text.MakeUpper().Matches( searchText.MakeUpper() );
171  }
172 
173  if( aSearchData.GetFlags() & wxFR_MATCHCASE )
174  return aText.Find( searchText ) != wxNOT_FOUND;
175 
176  return text.MakeUpper().Find( searchText.MakeUpper() ) != wxNOT_FOUND;
177 }
virtual bool IsReplaceable() const
Function IsReplaceable.
Definition: base_struct.h:515

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

150 {
151  int axis = aMirrorLeftRight ? axis_pos.x : axis_pos.y;
152  wxPoint newPos = m_Text.GetTextPos();
153 
154 #define INVERT( pos ) (pos) = axis - ( (pos) - axis )
155 
156  if( aMirrorLeftRight )
157  INVERT( newPos.x );
158  else
159  INVERT( newPos.y );
160 
161  m_Text.SetTextPos( newPos );
162 
163  // invert angle
165 
166  if( aMirrorLeftRight )
167  {
168  INVERT( m_crossBarO.y );
169  INVERT( m_crossBarF.y );
174  INVERT( m_arrowG1F.y );
175  INVERT( m_arrowG2F.y );
176  INVERT( m_arrowD1F.y );
177  INVERT( m_arrowD2F.y );
178  }
179  else
180  {
181  INVERT( m_crossBarO.y );
182  INVERT( m_crossBarF.y );
187  INVERT( m_arrowG1F.y );
188  INVERT( m_arrowG2F.y );
189  INVERT( m_arrowD1F.y );
190  INVERT( m_arrowD2F.y );
191  }
192 }
void SetTextAngle(double aAngle)
wxPoint m_crossBarF
wxPoint m_arrowD1F
void SetTextPos(const wxPoint &aPoint)
Definition: eda_text.h:231
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:232
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(), EDA_TEXT::SetTextPos(), wxPoint::x, and wxPoint::y.

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

94 {
95  m_Text.Offset( offset );
96 
97  m_crossBarO += offset;
98  m_crossBarF += offset;
99  m_featureLineGO += offset;
100  m_featureLineGF += offset;
101  m_featureLineDO += offset;
102  m_featureLineDF += offset;
103  m_arrowG1F += offset;
104  m_arrowG2F += offset;
105  m_arrowD1F += offset;
106  m_arrowD2F += offset;
107 }
void Offset(const wxPoint &aOffset)
Definition: eda_text.h:237
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 237 of file class_board_item.h.

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

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

◆ 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 207 of file base_struct.cpp.

208 {
209  wxFAIL_MSG( wxString::Format( wxT( "Less than operator not defined for item type %s." ),
210  GetChars( GetClass() ) ) );
211 
212  return false;
213 }
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 356 of file class_dimension.cpp.

357 {
358  BOARD* brd = GetBoard();
359 
360  if( brd->IsLayerVisible( m_Layer ) == false )
361  return;
362 
363  m_Text.Print( aFrame, DC, offset );
364 
365  auto gcolor = aFrame->Settings().Colors().GetLayerColor( m_Layer );
366  auto displ_opts = aFrame->GetDisplayOptions();
367  bool filled = displ_opts.m_DisplayDrawItemsFill;
368  int width = m_Width;
369 
370  if( filled )
371  {
372  GRLine( nullptr, DC, m_crossBarO + offset, m_crossBarF + offset, width, gcolor );
373  GRLine( nullptr, DC, m_featureLineGO + offset, m_featureLineGF + offset, width, gcolor );
374  GRLine( nullptr, DC, m_featureLineDO + offset, m_featureLineDF + offset, width, gcolor );
375  GRLine( nullptr, DC, m_crossBarF + offset, m_arrowD1F + offset, width, gcolor );
376  GRLine( nullptr, DC, m_crossBarF + offset, m_arrowD2F + offset, width, gcolor );
377  GRLine( nullptr, DC, m_crossBarO + offset, m_arrowG1F + offset, width, gcolor );
378  GRLine( nullptr, DC, m_crossBarO + offset, m_arrowG2F + offset, width, gcolor );
379  }
380  else
381  {
382  GRCSegm( nullptr, DC, m_crossBarO + offset, m_crossBarF + offset, width, gcolor );
383  GRCSegm( nullptr, DC, m_featureLineGO + offset, m_featureLineGF + offset, width, gcolor );
384  GRCSegm( nullptr, DC, m_featureLineDO + offset, m_featureLineDF + offset, width, gcolor );
385  GRCSegm( nullptr, DC, m_crossBarF + offset, m_arrowD1F + offset, width, gcolor );
386  GRCSegm( nullptr, DC, m_crossBarF + offset, m_arrowD2F + offset, width, gcolor );
387  GRCSegm( nullptr, DC, m_crossBarO + offset, m_arrowG1F + offset, width, gcolor );
388  GRCSegm( nullptr, DC, m_crossBarO + offset, m_arrowG2F + offset, width, gcolor );
389  }
390 }
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
const PCB_DISPLAY_OPTIONS & GetDisplayOptions() const
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.
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:449
BOARD holds information pertinent to a Pcbnew printed circuit board.
Definition: class_board.h:160
wxPoint m_crossBarO
wxPoint m_featureLineDO
wxPoint m_featureLineGF

References PCB_GENERAL_SETTINGS::Colors(), 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, PCB_DISPLAY_OPTIONS::m_DisplayDrawItemsFill, 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 
)
staticinherited

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

181 {
182  wxString searchString = (aSearchData.GetFlags() & wxFR_MATCHCASE) ? aText : aText.Upper();
183 
184  int result = searchString.Find( (aSearchData.GetFlags() & wxFR_MATCHCASE) ?
185  aSearchData.GetFindString() :
186  aSearchData.GetFindString().Upper() );
187 
188  if( result == wxNOT_FOUND )
189  return false;
190 
191  wxString prefix = aText.Left( result );
192  wxString suffix;
193 
194  if( aSearchData.GetFindString().length() + result < aText.length() )
195  suffix = aText.Right( aText.length() - ( aSearchData.GetFindString().length() + result ) );
196 
197  wxLogTrace( traceFindReplace, wxT( "Replacing '%s', prefix '%s', replace '%s', suffix '%s'." ),
198  GetChars( aText ), GetChars( prefix ), GetChars( aSearchData.GetReplaceString() ),
199  GetChars( suffix ) );
200 
201  aText = prefix + aSearchData.GetReplaceString() + suffix;
202 
203  return true;
204 }
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

References GetChars(), and traceFindReplace.

Referenced by SCH_FIELD::Replace(), EDA_TEXT::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_TEXT, SCH_FIELD, and SCH_SHEET_PIN.

Definition at line 503 of file base_struct.h.

503 { 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 110 of file class_dimension.cpp.

111 {
112  wxPoint tmp = m_Text.GetTextPos();
113  RotatePoint( &tmp, aRotCentre, aAngle );
114  m_Text.SetTextPos( tmp );
115 
116  double newAngle = m_Text.GetTextAngle() + aAngle;
117 
118  if( newAngle >= 3600 )
119  newAngle -= 3600;
120 
121  if( newAngle > 900 && newAngle < 2700 )
122  newAngle -= 1800;
123 
124  m_Text.SetTextAngle( newAngle );
125 
126  RotatePoint( &m_crossBarO, aRotCentre, aAngle );
127  RotatePoint( &m_crossBarF, aRotCentre, aAngle );
128  RotatePoint( &m_featureLineGO, aRotCentre, aAngle );
129  RotatePoint( &m_featureLineGF, aRotCentre, aAngle );
130  RotatePoint( &m_featureLineDO, aRotCentre, aAngle );
131  RotatePoint( &m_featureLineDF, aRotCentre, aAngle );
132  RotatePoint( &m_arrowG1F, aRotCentre, aAngle );
133  RotatePoint( &m_arrowG2F, aRotCentre, aAngle );
134  RotatePoint( &m_arrowD1F, aRotCentre, aAngle );
135  RotatePoint( &m_arrowD2F, aRotCentre, aAngle );
136 }
void SetTextAngle(double aAngle)
wxPoint m_crossBarF
wxPoint m_arrowD1F
void SetTextPos(const wxPoint &aPoint)
Definition: eda_text.h:231
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:208
wxPoint m_featureLineGO
wxPoint m_arrowG1F
wxPoint m_arrowD2F
wxPoint m_arrowG2F
const wxPoint & GetTextPos() const
Definition: eda_text.h:232
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 253 of file class_board_item.h.

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

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

◆ SetBrightened()

void EDA_ITEM::SetBrightened ( )
inlineinherited

Definition at line 231 of file base_struct.h.

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

References BRIGHTENED, and EDA_ITEM::SetFlags().

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

◆ SetEnd()

void DIMENSION::SetEnd ( const wxPoint aEnd,
int  aPrecision 
)

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.
aPrecisionnumber of decimal places for mils (scaled appropriately for other units).

Definition at line 203 of file class_dimension.cpp.

204 {
205  m_featureLineDO = aEnd;
206 
207  AdjustDimensionDetails( aPrecision );
208 }
void AdjustDimensionDetails(int aPrecision)
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 255 of file base_struct.h.

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

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_EDIT_TOOL::DoDelete(), SCH_LINE_WIRE_BUS_TOOL::doUnfoldBus(), 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(), 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(), 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 306 of file base_struct.h.

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

References EDA_ITEM::m_forceVisible.

◆ SetHeight()

void DIMENSION::SetHeight ( int  aHeight,
int  aPrecision 
)

Function SetHeight Sets the length of feature lines.

Parameters
aHeightis the new height.
aPrecisionnumber of decimal places for mils (scaled appropriately for other units).

Definition at line 211 of file class_dimension.cpp.

212 {
213  m_Height = aHeight;
214 
215  AdjustDimensionDetails( aPrecision );
216 }
int m_Height
length of feature lines
void AdjustDimensionDetails(int aPrecision)
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 230 of file base_struct.h.

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

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

87 {
88  m_Layer = aLayer;
89  m_Text.SetLayer( aLayer );
90 }
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().

◆ 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 208 of file class_board_item.h.

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

Referenced by PCB_EDITOR_CONTROL::modifyLockSelected().

◆ SetModified()

◆ SetOrigin()

void DIMENSION::SetOrigin ( const wxPoint aOrigin,
int  aPrecision 
)

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.
aPrecisionnumber of decimal places for mils (scaled appropriately for other units).

Definition at line 195 of file class_dimension.cpp.

196 {
197  m_featureLineGO = aOrigin;
198 
199  AdjustDimensionDetails( aPrecision );
200 }
wxPoint m_featureLineGO
void AdjustDimensionDetails(int aPrecision)
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 62 of file class_dimension.cpp.

63 {
64  m_Text.SetTextPos( aPos );
65 }
void SetTextPos(const wxPoint &aPoint)
Definition: eda_text.h:231
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 244 of file base_struct.h.

245  {
246  if( state )
247  m_Status |= type; // state = ON or OFF
248  else
249  m_Status &= ~type;
250  }
STATUS_FLAGS m_Status
Definition: base_struct.h:173

References EDA_ITEM::m_Status.

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

◆ SetStatus()

void EDA_ITEM::SetStatus ( STATUS_FLAGS  aStatus)
inlineinherited

Definition at line 253 of file base_struct.h.

253 { m_Status = aStatus; }
STATUS_FLAGS m_Status
Definition: base_struct.h:173

References EDA_ITEM::m_Status.

Referenced by BOARD_NETLIST_UPDATER::UpdateNetlist().

◆ SetText()

void DIMENSION::SetText ( const wxString &  NewText)

Definition at line 74 of file class_dimension.cpp.

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

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:222

References m_Text, and EDA_TEXT::SetTextSize().

◆ SetTimeStamp()

void EDA_ITEM::SetTimeStamp ( timestamp_t  aNewTimeStamp)
inlineinherited

Definition at line 212 of file base_struct.h.

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

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(), Diagnose(), SCH_EDIT_TOOL::Duplicate(), SCH_ITEM::Duplicate(), DIALOG_FOOTPRINT_BOARD_EDITOR::EditFootprint(), EDIT_TOOL::EditFpInFpEditor(), 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(), SCH_EDIT_FRAME::LoadSheetFromFile(), 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(), 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  aUnits,
bool  aUseMils 
)
inline

Definition at line 194 of file class_dimension.h.

195  {
196  m_Unit = aUnits;
197  m_UseMils = aUseMils;
198  }
bool m_UseMils
If inches, use mils.
EDA_UNITS m_Unit
0 = inches, 1 = mm

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(), and DIALOG_TEXT_PROPERTIES::TransferDataFromWindow().

◆ SetWireImage()

void EDA_ITEM::SetWireImage ( )
inlineinherited

Definition at line 228 of file base_struct.h.

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

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)
Definition: 3d_actions.cpp:31

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

534 { 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

Parameters
aImage= the item image which contains data to swap

Reimplemented from BOARD_ITEM.

Definition at line 527 of file class_dimension.cpp.

528 {
529  assert( aImage->Type() == PCB_DIMENSION_T );
530 
531  std::swap( *((DIMENSION*) this), *((DIMENSION*) aImage) );
532 }
class DIMENSION, a dimension (graphic item)
Definition: typeinfo.h:99
DIMENSION.
KICAD_T Type() const
Function Type()
Definition: base_struct.h:207

References PCB_DIMENSION_T, and EDA_ITEM::Type().

◆ Text() [1/2]

◆ Text() [2/2]

TEXTE_PCB& DIMENSION::Text ( ) const
inline

Definition at line 204 of file class_dimension.h.

204 { 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 133 of file class_board_item.cpp.

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

Referenced by process().

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

208  {
209  return m_StructType;
210  }
KICAD_T m_StructType
Run time identification, keep private so it can never be changed after a constructor sets it.
Definition: base_struct.h:172

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(), SCH_SCREENS::buildScreenList(), calcArea(), calcMaxArea(), PCB_INSPECTION_TOOL::calculateSelectionRatsnest(), POINT_EDITOR::canAddCorner(), SCH_JUNCTION::CanConnect(), SCH_NO_CONNECT::CanConnect(), SCH_BUS_WIRE_ENTRY::CanConnect(), SCH_BUS_BUS_ENTRY::CanConnect(), SCH_LINE::CanConnect(), SCH_LABEL::CanConnect(), SCH_GLOBALLABEL::CanConnect(), SCH_HIERLABEL::CanConnect(), SCH_SHEET::CanConnect(), SCH_COMPONENT::CanConnect(), ROUTER_TOOL::CanInlineDrag(), SCH_MARKER::ClassOf(), SCH_JUNCTION::ClassOf(), TEXTE_PCB::ClassOf(), SCH_NO_CONNECT::ClassOf(), BOARD_CONNECTED_ITEM::ClassOf(), SCH_PIN::ClassOf(), EDGE_MODULE::ClassOf(), PCB_TARGET::ClassOf(), SCH_LINE::ClassOf(), SCH_FIELD::ClassOf(), TEXTE_MODULE::ClassOf(), DRAWSEGMENT::ClassOf(), MARKER_PCB::ClassOf(), ZONE_CONTAINER::ClassOf(), TRACK::ClassOf(), SCH_BITMAP::ClassOf(), ClassOf(), NETINFO_ITEM::ClassOf(), SCH_SHEET_PIN::ClassOf(), MODULE::ClassOf(), SCH_BUS_WIRE_ENTRY::ClassOf(), SCH_SCREEN::ClassOf(), D_PAD::ClassOf(), SCH_COMPONENT::ClassOf(), SCH_BUS_BUS_ENTRY::ClassOf(), BOARD::ClassOf(), SCH_TEXT::ClassOf(), SCH_SHEET::ClassOf(), VIA::ClassOf(), SCH_LABEL::ClassOf(), SCH_GLOBALLABEL::ClassOf(), SCH_HIERLABEL::ClassOf(), TRACKS_CLEANER::cleanupSegments(), LIB_RECTANGLE::compare(), LIB_BEZIER::compare(), LIB_CIRCLE::compare(), LIB_TEXT::compare(), LIB_POLYLINE::compare(), LIB_ARC::compare(), LIB_FIELD::compare(), LIB_PIN::compare(), GRID_HELPER::computeAnchors(), SCH_BUS_WIRE_ENTRY::ConnectionPropagatesTo(), EE_RTREE::contains(), SCH_EDIT_FRAME::ConvertTextType(), MODULE::CoverageRatio(), CINFO3D_VISU::createLayers(), SCH_EDIT_FRAME::CreateNewText(), CINFO3D_VISU::createNewTrack(), NETLIST_EXPORTER::CreatePinList(), D_PAD::D_PAD(), 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(), ALIGN_DISTRIBUTE_TOOL::doAlignLeft(), ALIGN_DISTRIBUTE_TOOL::doAlignRight(), SCH_EDITOR_CONTROL::doCopy(), SCH_EDIT_TOOL::DoDelete(), 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::ercCheckBusToBusEntryConflicts(), CONNECTION_GRAPH::ercCheckLabels(), NETLIST_EXPORTER::findNextComponent(), 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(), TEXTE_PCB::GetMsgPanelInfo(), SCH_TEXT::GetMsgPanelInfo(), CONNECTION_SUBGRAPH::GetNameForDriver(), CONNECTIVITY_DATA::GetNetItems(), LIB_PART::GetNextDrawItem(), DRAWSEGMENT::GetParentModule(), LIB_PART::GetPin(), SCH_COMPONENT::GetPinPhysicalPosition(), getRect(), KIGFX::SCH_PAINTER::getRenderColor(), PCBNEW_SELECTION::GetTopLeftItem(), SELECTION_TOOL::GuessSelectionCandidates(), EE_SELECTION_TOOL::GuessSelectionCandidates(), hash_eda(), EE_SELECTION_TOOL::highlight(), SELECTION_TOOL::highlight(), KIGFX::SCH_VIEW::HighlightItem(), SCH_EDIT_TOOL::Init(), ROUTER_TOOL::InlineBreakTrack(), ROUTER_TOOL::InlineDrag(), EE_RTREE::insert(), EE_COLLECTOR::Inspect(), GENERAL_COLLECTOR::Inspect(), PCB_LAYER_COLLECTOR::Inspect(), ARRAY_CREATOR::Invoke(), SCH_LINE_WIRE_BUS_TOOL::IsDrawingLineWireOrBus(), TRACK::IsNull(), SCH_LINE::IsParallel(), SCH_SCREEN::IsTerminalPoint(), BOARD_ITEM::IsTrack(), itemIsIncludedByFilter(), CLIPBOARD_IO::Load(), PNS_PCBNEW_RULE_RESOLVER::localPadClearance(), 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(), 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(), SCH_SCREEN::Plot(), BRDITEMS_PLOTTER::Plot_1_EdgeModule(), SCH_SCREEN::Print(), 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(), SCH_BASE_FRAME::RefreshSelection(), EE_RTREE::remove(), MODULE::Remove(), CN_CONNECTIVITY_ALGO::Remove(), BOARD::Remove(), POINT_EDITOR::removeCorner(), POINT_EDITOR::removeCornerCondition(), LIB_PART::RemoveDrawItem(), SCH_SHEET::RemovePin(), SCH_EDIT_TOOL::RepeatDrawItem(), CONNECTION_SUBGRAPH::ResolveDrivers(), WS_PROXY_UNDO_ITEM::Restore(), 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(), SELECTION_TOOL::select(), SELECTION_TOOL::Selectable(), EE_SELECTION_TOOL::Selectable(), SELECTION_TOOL::selectConnectedTracks(), ITEM_PICKER::SetItem(), DIALOG_LABEL_EDITOR::SetTitle(), PCB_EDIT_FRAME::SetTrackSegmentWidth(), ShowClearance(), BOARD_COMMIT::Stage(), 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(), VIA::SwapData(), SCH_SHEET::SwapData(), SCH_COMPONENT::SwapData(), MODULE::SwapData(), ZONE_CONTAINER::SwapData(), D_PAD::SwapData(), SwapItemData(), TEXTE_MODULE::TEXTE_MODULE(), AR_MATRIX::TraceSegmentPcb(), DIALOG_LABEL_EDITOR::TransferDataFromWindow(), DIALOG_FIELDS_EDITOR_GLOBAL::TransferDataToWindow(), DIALOG_TEXT_PROPERTIES::TransferDataToWindow(), DIALOG_LABEL_EDITOR::TransferDataToWindow(), TRACK::TransformShapeWithClearanceToPolygon(), LIB_DRAWING_TOOLS::TwoClickPlace(), EE_SELECTION_TOOL::unhighlight(), SELECTION_TOOL::unhighlight(), SCH_TEXT::UpdateDanglingState(), EE_POINT_EDITOR::updateItem(), POINT_EDITOR::updateItem(), SCH_EDITOR_CONTROL::UpdateNetHighlighting(), EE_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().

◆ UpdateHeight()

void DIMENSION::UpdateHeight ( )

Function UpdateHeight Updates stored height basing on points coordinates.

Definition at line 219 of file class_dimension.cpp.

220 {
221  VECTOR2D featureLine( m_crossBarO - m_featureLineGO );
223 
224  if( featureLine.Cross( crossBar ) > 0 )
225  m_Height = -featureLine.EuclideanNorm();
226  else
227  m_Height = featureLine.EuclideanNorm();
228 }
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 512 of file class_dimension.cpp.

513 {
514  BOX2I dimBBox = BOX2I( VECTOR2I( GetBoundingBox().GetPosition() ),
515  VECTOR2I( GetBoundingBox().GetSize() ) );
516  dimBBox.Merge( m_Text.ViewBBox() );
517 
518  return dimBBox;
519 }
BOX2< VECTOR2I > BOX2I
Definition: box2.h:521
TEXTE_PCB m_Text
VECTOR2< int > VECTOR2I
Definition: vector2d.h:594
BOX2 handles a 2-D bounding box, built on top of an origin point and size vector, both of templated c...
Definition: box2.h:42
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:385
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, MY_DRAWING, 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, TEXTE_MODULE, TRACK, ZONE_CONTAINER, MARKER_PCB, and KIGFX::ORIGIN_VIEWITEM.

Definition at line 80 of file class_board_item.cpp.

81 {
82  // Basic fallback
83  aCount = 1;
84  aLayers[0] = m_Layer;
85 }
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 MODULE_ZONE_CONTAINER, D_PAD, MODULE, VIA, GERBER_DRAW_ITEM, TEXTE_MODULE, TRACK, 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()(), GRID_HELPER::queryVisible(), and SELECTION_TOOL::Selectable().

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

Definition at line 128 of file base_struct.cpp.

129 {
130 #if 0 && defined(DEBUG)
131  std::cout << GetClass().mb_str() << ' ';
132 #endif
133 
134  if( IsType( scanTypes ) )
135  {
136  if( SEARCH_RESULT::QUIT == inspector( this, testData ) )
137  return SEARCH_RESULT::QUIT;
138  }
139 
141 }
virtual bool IsType(const KICAD_T aScanTypes[]) const
Function IsType Checks whether the item is one of the listed types.
Definition: base_struct.h:284
virtual wxString GetClass() const =0
Function GetClass returns the class name.

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

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

Member Data Documentation

◆ m_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 181 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_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 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().

◆ ZeroOffset

wxPoint BOARD_ITEM::ZeroOffset
staticinherited

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

Definition at line 123 of file class_board_item.h.

Referenced by BOARD::GetPosition().


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