KiCad PCB EDA Suite
LIB_ARC Class Reference

#include <lib_arc.h>

Inheritance diagram for LIB_ARC:
LIB_ITEM EDA_ITEM KIGFX::VIEW_ITEM

Public Types

enum  LIB_CONVERT : int { BASE = 1, DEMORGAN = 2 }
 

Public Member Functions

 LIB_ARC (LIB_PART *aParent)
 
 ~LIB_ARC ()
 
wxString GetClass () const override
 Function GetClass returns the class name. More...
 
wxString GetTypeName () override
 Provide a user-consumable name of the object type. More...
 
bool HitTest (const wxPoint &aPosition, int aAccuracy=0) 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...
 
const EDA_RECT GetBoundingBox () const override
 Function GetBoundingBox returns the orthogonal, bounding box of this object for display purposes. 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...
 
int GetPenSize () const override
 
void BeginEdit (const wxPoint aStartPoint) override
 Begin drawing a component library draw item at aPosition. More...
 
void CalcEdit (const wxPoint &aPosition) override
 Calculates the attributes of an item at aPosition when it is being edited. More...
 
void SetEditState (int aState)
 
void Offset (const wxPoint &aOffset) override
 Set the drawing object by aOffset from the current position. More...
 
bool Inside (EDA_RECT &aRect) const override
 Test if any part of the draw object is inside rectangle bounds of aRect. More...
 
void MoveTo (const wxPoint &aPosition) override
 Move a draw object to aPosition. More...
 
wxPoint GetPosition () const override
 
void MirrorHorizontal (const wxPoint &aCenter) override
 Mirror the draw object along the horizontal (X) axis about aCenter point. More...
 
void MirrorVertical (const wxPoint &aCenter) override
 Mirror the draw object along the MirrorVertical (Y) axis about aCenter point. More...
 
void Rotate (const wxPoint &aCenter, bool aRotateCCW=true) override
 Rotate the object about aCenter point. More...
 
void Plot (PLOTTER *aPlotter, const wxPoint &aOffset, bool aFill, const TRANSFORM &aTransform) override
 Plot the draw item using the plot object. More...
 
int GetWidth () const override
 
void SetWidth (int aWidth) override
 
void SetRadius (int aRadius)
 
int GetRadius () const
 
void SetFirstRadiusAngle (int aAngle)
 
int GetFirstRadiusAngle () const
 
void SetSecondRadiusAngle (int aAngle)
 
int GetSecondRadiusAngle () const
 
wxPoint GetStart () const
 
void SetStart (const wxPoint &aPoint)
 
wxPoint GetEnd () const
 
void SetEnd (const wxPoint &aPoint)
 
void CalcRadiusAngles ()
 Calculate the radius and angle of an arc using the start, end, and center points. 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 bool ContinueEdit (const wxPoint aPosition)
 Continue an edit in progress at aPosition. More...
 
virtual void EndEdit ()
 End an object editing action. More...
 
virtual void Print (wxDC *aDC, const wxPoint &aOffset, void *aData, const TRANSFORM &aTransform)
 Draw an item. More...
 
LIB_PARTGetParent () const
 
void ViewGetLayers (int aLayers[], int &aCount) const override
 Function ViewGetLayers() Returns the all the layers within the VIEW the object is painted on. More...
 
bool operator== (const LIB_ITEM &aOther) const
 Test LIB_ITEM objects for equivalence. More...
 
bool operator== (const LIB_ITEM *aOther) const
 
bool operator< (const LIB_ITEM &aOther) const
 Test if another draw item is less than this draw object. More...
 
bool operator< (const EDA_ITEM &aItem) const
 Test if another item is less than this object. More...
 
void SetPosition (const wxPoint &aPosition)
 
bool IsFillable () const
 Check if draw object can be filled. More...
 
virtual COLOR4D GetDefaultColor ()
 
void SetUnit (int aUnit)
 
int GetUnit () const
 
void SetConvert (int aConvert)
 
int GetConvert () const
 
void SetFillMode (FILL_T aFillMode)
 
FILL_T GetFillMode () const
 
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...
 
virtual const BOX2I ViewBBox () const override
 Function ViewBBox() returns the bounding box of the item covering all its layers. More...
 
virtual void ViewDraw (int aLayer, VIEW *aView) const
 Function ViewDraw() Draws the parts of the object belonging to layer aLayer. More...
 
virtual unsigned int ViewGetLOD (int aLayer, VIEW *aView) const
 Function ViewGetLOD() Returns the level of detail (LOD) of the item. More...
 
VIEW_ITEM_DATA * viewPrivData () const
 
void ClearViewPrivData ()
 

Static Public Member Functions

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

Protected Member Functions

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

Protected Attributes

int m_Unit
 Unit identification for multiple parts per package. More...
 
int m_Convert
 Shape identification for alternate body styles. More...
 
FILL_T m_Fill
 The body fill type. More...
 
bool m_isFillable
 
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 Types

enum  SELECT_T { ARC_STATUS_START, ARC_STATUS_END, ARC_STATUS_OUTLINE }
 

Private Member Functions

void print (wxDC *aDC, const wxPoint &aOffset, void *aData, const TRANSFORM &aTransform) override
 Print the item to aDC. More...
 
int compare (const LIB_ITEM &aOther) const override
 Provide the draw object specific comparison called by the == and < operators. More...
 

Private Attributes

int m_Radius
 
int m_t1
 
int m_t2
 
wxPoint m_ArcStart
 
wxPoint m_ArcEnd
 
wxPoint m_Pos
 
int m_Width
 
int m_editState
 

Detailed Description

Definition at line 35 of file lib_arc.h.

Member Enumeration Documentation

◆ LIB_CONVERT

enum LIB_ITEM::LIB_CONVERT : int
inherited
Enumerator
BASE 
DEMORGAN 

Definition at line 107 of file lib_item.h.

107 : int { BASE = 1, DEMORGAN = 2 };

◆ SELECT_T

enum LIB_ARC::SELECT_T
private
Enumerator
ARC_STATUS_START 
ARC_STATUS_END 
ARC_STATUS_OUTLINE 

Definition at line 37 of file lib_arc.h.

Constructor & Destructor Documentation

◆ LIB_ARC()

LIB_ARC::LIB_ARC ( LIB_PART aParent)

Definition at line 49 of file lib_arc.cpp.

49  : LIB_ITEM( LIB_ARC_T, aParent )
50 {
51  m_Radius = 0;
52  m_t1 = 0;
53  m_t2 = 0;
54  m_Width = 0;
55  m_Fill = NO_FILL;
56  m_isFillable = true;
57  m_editState = 0;
58 }
int m_Radius
Definition: lib_arc.h:44
int m_t1
Definition: lib_arc.h:45
int m_t2
Definition: lib_arc.h:46
bool m_isFillable
Definition: lib_item.h:94
int m_editState
Definition: lib_arc.h:51
FILL_T m_Fill
The body fill type.
Definition: lib_item.h:93
LIB_ITEM(KICAD_T aType, LIB_PART *aComponent=NULL, int aUnit=0, int aConvert=0, FILL_T aFillType=NO_FILL)
Definition: lib_item.cpp:37
int m_Width
Definition: lib_arc.h:50

References m_editState, LIB_ITEM::m_Fill, LIB_ITEM::m_isFillable, m_Radius, m_t1, m_t2, m_Width, and NO_FILL.

Referenced by Clone().

◆ ~LIB_ARC()

LIB_ARC::~LIB_ARC ( )
inline

Definition at line 61 of file lib_arc.h.

61 { }

Member Function Documentation

◆ BeginEdit()

void LIB_ARC::BeginEdit ( const wxPoint  aPosition)
overridevirtual

Begin drawing a component library draw item at aPosition.

It typically would be called on a left click when a draw tool is selected in the component library editor and one of the graphics tools is selected.

Parameters
aPositionThe position in drawing coordinates where the drawing was started. May or may not be required depending on the item being drawn.

Reimplemented from LIB_ITEM.

Definition at line 426 of file lib_arc.cpp.

427 {
428  m_ArcStart = m_ArcEnd = aPosition;
429  m_editState = 1;
430 }
wxPoint m_ArcEnd
Definition: lib_arc.h:48
int m_editState
Definition: lib_arc.h:51
wxPoint m_ArcStart
Definition: lib_arc.h:47

References m_ArcEnd, m_ArcStart, and m_editState.

◆ CalcEdit()

void LIB_ARC::CalcEdit ( const wxPoint aPosition)
overridevirtual

Calculates the attributes of an item at aPosition when it is being edited.

This method gets called by the Draw() method when the item is being edited. This probably should be a pure virtual method but bezier curves are not yet editable in the component library editor. Therefore, the default method does nothing.

Parameters
aPositionThe current mouse position in drawing coordinates.

Reimplemented from LIB_ITEM.

Definition at line 433 of file lib_arc.cpp.

434 {
435 #define sq( x ) pow( x, 2 )
436 
437  // Edit state 0: drawing: place ArcStart
438  // Edit state 1: drawing: place ArcEnd (center calculated for 90-degree subtended angle)
439  // Edit state 2: point editing: move ArcStart (center calculated for invariant subtended angle)
440  // Edit state 3: point editing: move ArcEnd (center calculated for invariant subtended angle)
441  // Edit state 4: point editing: move center
442 
443  switch( m_editState )
444  {
445  case 0:
446  m_ArcStart = aPosition;
447  m_ArcEnd = aPosition;
448  m_Pos = aPosition;
449  m_Radius = 0;
450  m_t1 = 0;
451  m_t2 = 0;
452  return;
453 
454  case 1:
455  m_ArcEnd = aPosition;
456  m_Radius = KiROUND( sqrt( pow( GetLineLength( m_ArcStart, m_ArcEnd ), 2 ) / 2.0 ) );
457  break;
458 
459  case 2:
460  case 3:
461  {
463  double chordBefore = sq( v.x ) + sq( v.y );
464 
465  if( m_editState == 2 )
466  m_ArcStart = aPosition;
467  else
468  m_ArcEnd = aPosition;
469 
470  v = m_ArcStart - m_ArcEnd;
471  double chordAfter = sq( v.x ) + sq( v.y );
472  double ratio = chordAfter / chordBefore;
473 
474  if( ratio > 0 )
475  {
476  m_Radius = int( sqrt( m_Radius * m_Radius * ratio ) ) + 1;
477  m_Radius = std::max( m_Radius, int( sqrt( chordAfter ) / 2 ) + 1 );
478  }
479 
480  break;
481  }
482 
483  case 4:
484  {
485  double chordA = GetLineLength( m_ArcStart, aPosition );
486  double chordB = GetLineLength( m_ArcEnd, aPosition );
487  m_Radius = int( ( chordA + chordB ) / 2.0 ) + 1;
488  break;
489  }
490  }
491 
492  // Calculate center based on start, end, and radius
493  //
494  // Let 'l' be the length of the chord and 'm' the middle point of the chord
495  double l = GetLineLength( m_ArcStart, m_ArcEnd );
496  wxPoint m = ( m_ArcStart + m_ArcEnd ) / 2;
497 
498  // Calculate 'd', the vector from the chord midpoint to the center
499  wxPoint d;
500  d.x = KiROUND( sqrt( sq( m_Radius ) - sq( l/2 ) ) * ( m_ArcStart.y - m_ArcEnd.y ) / l );
501  d.y = KiROUND( sqrt( sq( m_Radius ) - sq( l/2 ) ) * ( m_ArcEnd.x - m_ArcStart.x ) / l );
502 
503  wxPoint c1 = m + d;
504  wxPoint c2 = m - d;
505 
506  // Solution gives us 2 centers; we need to pick one:
507  switch( m_editState )
508  {
509  case 1:
510  {
511  // Keep center clockwise from chord while drawing
512  wxPoint chordVector = twoPointVector( m_ArcStart, m_ArcEnd );
513  double chordAngle = ArcTangente( chordVector.y, chordVector.x );
514  NORMALIZE_ANGLE_POS( chordAngle );
515 
516  wxPoint c1Test = c1;
517  RotatePoint( &c1Test, m_ArcStart, -chordAngle );
518 
519  m_Pos = c1Test.x > 0 ? c2 : c1;
520  }
521  break;
522 
523  case 2:
524  case 3:
525  // Pick the one closer to the old center
526  m_Pos = ( GetLineLength( c1, m_Pos ) < GetLineLength( c2, m_Pos ) ) ? c1 : c2;
527  break;
528 
529  case 4:
530  // Pick the one closer to the mouse position
531  m_Pos = ( GetLineLength( c1, aPosition ) < GetLineLength( c2, aPosition ) ) ? c1 : c2;
532  break;
533  }
534 
536 }
int m_Radius
Definition: lib_arc.h:44
static wxPoint twoPointVector(const wxPoint &startPoint, const wxPoint &endPoint)
Definition: lib_arc.cpp:43
int m_t1
Definition: lib_arc.h:45
double GetLineLength(const wxPoint &aPointA, const wxPoint &aPointB)
Function GetLineLength returns the length of a line segment defined by aPointA and aPointB.
Definition: trigo.h:202
int m_t2
Definition: lib_arc.h:46
void CalcRadiusAngles()
Calculate the radius and angle of an arc using the start, end, and center points.
Definition: lib_arc.cpp:539
wxPoint m_ArcEnd
Definition: lib_arc.h:48
void RotatePoint(int *pX, int *pY, double angle)
Definition: trigo.cpp:208
void NORMALIZE_ANGLE_POS(T &Angle)
Definition: trigo.h:252
wxPoint m_Pos
Definition: lib_arc.h:49
int m_editState
Definition: lib_arc.h:51
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
double ArcTangente(int dy, int dx)
Definition: trigo.cpp:162
#define sq(x)
wxPoint m_ArcStart
Definition: lib_arc.h:47

References ArcTangente(), CalcRadiusAngles(), GetLineLength(), KiROUND(), m_ArcEnd, m_ArcStart, m_editState, m_Pos, m_Radius, m_t1, m_t2, NORMALIZE_ANGLE_POS(), RotatePoint(), sq, twoPointVector(), wxPoint::x, and wxPoint::y.

Referenced by EE_POINT_EDITOR::updateItem().

◆ CalcRadiusAngles()

void LIB_ARC::CalcRadiusAngles ( )

Calculate the radius and angle of an arc using the start, end, and center points.

Definition at line 539 of file lib_arc.cpp.

540 {
541  wxPoint centerStartVector = twoPointVector( m_Pos, m_ArcStart );
542  wxPoint centerEndVector = twoPointVector( m_Pos, m_ArcEnd );
543 
544  m_Radius = KiROUND( EuclideanNorm( centerStartVector ) );
545 
546  // Angles in eeschema are still integers
547  m_t1 = KiROUND( ArcTangente( centerStartVector.y, centerStartVector.x ) );
548  m_t2 = KiROUND( ArcTangente( centerEndVector.y, centerEndVector.x ) );
549 
551  NORMALIZE_ANGLE_POS( m_t2 ); // angles = 0 .. 3600
552 
553  // Restrict angle to less than 180 to avoid PBS display mirror Trace because it is
554  // assumed that the arc is less than 180 deg to find orientation after rotate or mirror.
555  if( (m_t2 - m_t1) > 1800 )
556  m_t2 -= 3600;
557  else if( (m_t2 - m_t1) <= -1800 )
558  m_t2 += 3600;
559 
560  while( (m_t2 - m_t1) >= 1800 )
561  {
562  m_t2--;
563  m_t1++;
564  }
565 
566  while( (m_t1 - m_t2) >= 1800 )
567  {
568  m_t2++;
569  m_t1--;
570  }
571 
573 
574  if( !IsMoving() )
576 }
double EuclideanNorm(const wxPoint &vector)
Euclidean norm of a 2D vector.
Definition: trigo.h:123
int m_Radius
Definition: lib_arc.h:44
static wxPoint twoPointVector(const wxPoint &startPoint, const wxPoint &endPoint)
Definition: lib_arc.cpp:43
int m_t1
Definition: lib_arc.h:45
int m_t2
Definition: lib_arc.h:46
bool IsMoving() const
Definition: base_struct.h:220
wxPoint m_ArcEnd
Definition: lib_arc.h:48
void NORMALIZE_ANGLE_POS(T &Angle)
Definition: trigo.h:252
wxPoint m_Pos
Definition: lib_arc.h:49
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
double ArcTangente(int dy, int dx)
Definition: trigo.cpp:162
wxPoint m_ArcStart
Definition: lib_arc.h:47

References ArcTangente(), EuclideanNorm(), EDA_ITEM::IsMoving(), KiROUND(), m_ArcEnd, m_ArcStart, m_Pos, m_Radius, m_t1, m_t2, NORMALIZE_ANGLE_POS(), twoPointVector(), wxPoint::x, and wxPoint::y.

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

◆ 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 * LIB_ARC::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 129 of file lib_arc.cpp.

130 {
131  return new LIB_ARC( *this );
132 }
LIB_ARC(LIB_PART *aParent)
Definition: lib_arc.cpp:49

References LIB_ARC().

◆ compare()

int LIB_ARC::compare ( const LIB_ITEM aOther) const
overrideprivatevirtual

Provide the draw object specific comparison called by the == and < operators.

The base object sort order which always proceeds the derived object sort order is as follows:

  • Component alternate part (DeMorgan) number.
  • Component part number.
  • KICAD_T enum value.
  • Result of derived classes comparison.
Parameters
aOtherA reference to the other LIB_ITEM to compare the arc against.
Returns
An integer value less than 0 if the object is less than aOther ojbect, zero if the object is equal to aOther object, or greater than 0 if the object is greater than aOther object.

The arc specific sort order is as follows:

  • Arc horizontal (X) position.
  • Arc vertical (Y) position.
  • Arc start angle.
  • Arc end angle.

Implements LIB_ITEM.

Definition at line 135 of file lib_arc.cpp.

136 {
137  wxASSERT( aOther.Type() == LIB_ARC_T );
138 
139  const LIB_ARC* tmp = ( LIB_ARC* ) &aOther;
140 
141  if( m_Pos.x != tmp->m_Pos.x )
142  return m_Pos.x - tmp->m_Pos.x;
143 
144  if( m_Pos.y != tmp->m_Pos.y )
145  return m_Pos.y - tmp->m_Pos.y;
146 
147  if( m_t1 != tmp->m_t1 )
148  return m_t1 - tmp->m_t1;
149 
150  if( m_t2 != tmp->m_t2 )
151  return m_t2 - tmp->m_t2;
152 
153  return 0;
154 }
int m_t1
Definition: lib_arc.h:45
int m_t2
Definition: lib_arc.h:46
wxPoint m_Pos
Definition: lib_arc.h:49
KICAD_T Type() const
Function Type()
Definition: base_struct.h:207

References LIB_ARC_T, m_Pos, m_t1, m_t2, EDA_ITEM::Type(), wxPoint::x, and wxPoint::y.

◆ ContinueEdit()

virtual bool LIB_ITEM::ContinueEdit ( const wxPoint  aPosition)
inlinevirtualinherited

Continue an edit in progress at aPosition.

This is used to perform the next action while drawing an item. This would be called for each additional left click when the mouse is captured while the item is being drawn.

Parameters
aPositionThe position of the mouse left click in drawing coordinates.
Returns
True if additional mouse clicks are required to complete the edit in progress.

Reimplemented in LIB_POLYLINE.

Definition at line 136 of file lib_item.h.

136 { return false; }

Referenced by LIB_DRAWING_TOOLS::DrawShape().

◆ EndEdit()

virtual void LIB_ITEM::EndEdit ( )
inlinevirtualinherited

End an object editing action.

This is used to end or abort an edit action in progress initiated by BeginEdit().

Reimplemented in LIB_POLYLINE.

Definition at line 143 of file lib_item.h.

143 {}

Referenced by LIB_DRAWING_TOOLS::DrawShape().

◆ GetBoundingBox()

const EDA_RECT LIB_ARC::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 330 of file lib_arc.cpp.

331 {
332  int minX, minY, maxX, maxY, angleStart, angleEnd;
333  EDA_RECT rect;
334  wxPoint nullPoint, startPos, endPos, centerPos;
335  wxPoint normStart = m_ArcStart - m_Pos;
336  wxPoint normEnd = m_ArcEnd - m_Pos;
337 
338  if( ( normStart == nullPoint ) || ( normEnd == nullPoint ) || ( m_Radius == 0 ) )
339  {
340  wxLogDebug( wxT("Invalid arc drawing definition, center(%d, %d), start(%d, %d), "
341  "end(%d, %d), radius %d" ),
343  m_ArcEnd.y, m_Radius );
344  return rect;
345  }
346 
350  angleStart = m_t1;
351  angleEnd = m_t2;
352 
353  if( DefaultTransform.MapAngles( &angleStart, &angleEnd ) )
354  {
355  std::swap( endPos.x, startPos.x );
356  std::swap( endPos.y, startPos.y );
357  }
358 
359  /* Start with the start and end point of the arc. */
360  minX = std::min( startPos.x, endPos.x );
361  minY = std::min( startPos.y, endPos.y );
362  maxX = std::max( startPos.x, endPos.x );
363  maxY = std::max( startPos.y, endPos.y );
364 
365  /* Zero degrees is a special case. */
366  if( angleStart == 0 )
367  maxX = centerPos.x + m_Radius;
368 
369  /* Arc end angle wrapped passed 360. */
370  if( angleStart > angleEnd )
371  angleEnd += 3600;
372 
373  if( angleStart <= 900 && angleEnd >= 900 ) /* 90 deg */
374  maxY = centerPos.y + m_Radius;
375 
376  if( angleStart <= 1800 && angleEnd >= 1800 ) /* 180 deg */
377  minX = centerPos.x - m_Radius;
378 
379  if( angleStart <= 2700 && angleEnd >= 2700 ) /* 270 deg */
380  minY = centerPos.y - m_Radius;
381 
382  if( angleStart <= 3600 && angleEnd >= 3600 ) /* 0 deg */
383  maxX = centerPos.x + m_Radius;
384 
385  rect.SetOrigin( minX, minY );
386  rect.SetEnd( maxX, maxY );
387  rect.Inflate( ( GetPenSize()+1 ) / 2 );
388 
389  return rect;
390 }
int m_Radius
Definition: lib_arc.h:44
int m_t1
Definition: lib_arc.h:45
int m_t2
Definition: lib_arc.h:46
TRANSFORM DefaultTransform
void SetOrigin(const wxPoint &pos)
Definition: eda_rect.h:131
wxPoint m_ArcEnd
Definition: lib_arc.h:48
wxPoint TransformCoordinate(const wxPoint &aPoint) const
Calculate a new coordinate according to the mirror/rotation transform.
Definition: transform.cpp:42
wxPoint m_Pos
Definition: lib_arc.h:49
void SetEnd(int x, int y)
Definition: eda_rect.h:192
int GetPenSize() const override
Definition: lib_arc.cpp:286
EDA_RECT handles the component boundary box.
Definition: eda_rect.h:44
bool MapAngles(int *aAngle1, int *aAngle2) const
Calculate new angles according to the transform.
Definition: transform.cpp:81
wxPoint m_ArcStart
Definition: lib_arc.h:47
EDA_RECT & Inflate(wxCoord dx, wxCoord dy)
Function Inflate inflates the rectangle horizontally by dx and vertically by dy.

References DefaultTransform, GetPenSize(), EDA_RECT::Inflate(), m_ArcEnd, m_ArcStart, m_Pos, m_Radius, m_t1, m_t2, TRANSFORM::MapAngles(), EDA_RECT::SetEnd(), EDA_RECT::SetOrigin(), TRANSFORM::TransformCoordinate(), wxPoint::x, and wxPoint::y.

Referenced by GetMsgPanelInfo(), and HitTest().

◆ GetClass()

wxString LIB_ARC::GetClass ( ) const
inlineoverridevirtual

Function GetClass returns the class name.

Returns
wxString

Implements EDA_ITEM.

Definition at line 63 of file lib_arc.h.

64  {
65  return wxT( "LIB_ARC" );
66  }

◆ GetConvert()

◆ GetDefaultColor()

COLOR4D LIB_ITEM::GetDefaultColor ( )
virtualinherited

Reimplemented in LIB_FIELD.

Definition at line 139 of file lib_item.cpp.

140 {
141  return GetLayerColor( LAYER_DEVICE );
142 }
COLOR4D GetLayerColor(SCH_LAYER_ID aLayer)

References GetLayerColor(), and LAYER_DEVICE.

Referenced by LIB_TEXT::Plot(), and LIB_TEXT::print().

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

wxPoint LIB_ARC::GetEnd ( ) const
inline

◆ GetFillMode()

◆ GetFirstRadiusAngle()

int LIB_ARC::GetFirstRadiusAngle ( ) const
inline

Definition at line 108 of file lib_arc.h.

108 { return m_t1; }
int m_t1
Definition: lib_arc.h:45

References m_t1.

Referenced by KIGFX::SCH_PAINTER::draw(), and SCH_LEGACY_PLUGIN_CACHE::saveArc().

◆ GetFlags()

◆ GetMenuImage()

BITMAP_DEF LIB_ARC::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 420 of file lib_arc.cpp.

421 {
422  return add_arc_xpm;
423 }
const BITMAP_OPAQUE add_arc_xpm[1]
Definition: add_arc.cpp:37

References add_arc_xpm.

◆ GetMsgPanelInfo()

void LIB_ARC::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 393 of file lib_arc.cpp.

394 {
395  wxString msg;
396  EDA_RECT bBox = GetBoundingBox();
397 
398  LIB_ITEM::GetMsgPanelInfo( aUnits, aList );
399 
400  msg = MessageTextFromValue( aUnits, m_Width, true );
401 
402  aList.emplace_back( _( "Line Width" ), msg, BLUE );
403 
404  msg.Printf( wxT( "(%d, %d, %d, %d)" ), bBox.GetOrigin().x,
405  bBox.GetOrigin().y, bBox.GetEnd().x, bBox.GetEnd().y );
406 
407  aList.emplace_back( _( "Bounding Box" ), msg, BROWN );
408 }
Definition: colors.h:57
void GetMsgPanelInfo(EDA_UNITS aUnits, std::vector< MSG_PANEL_ITEM > &aList) override
Display basic info (type, part and convert) about the current item in message panel.
Definition: lib_item.cpp:52
wxString MessageTextFromValue(EDA_UNITS aUnits, int aValue, bool aUseMils)
Definition: base_units.cpp:127
const EDA_RECT GetBoundingBox() const override
Function GetBoundingBox returns the orthogonal, bounding box of this object for display purposes.
Definition: lib_arc.cpp:330
const wxPoint GetEnd() const
Definition: eda_rect.h:116
const wxPoint GetOrigin() const
Definition: eda_rect.h:114
#define _(s)
Definition: 3d_actions.cpp:31
EDA_RECT handles the component boundary box.
Definition: eda_rect.h:44
int m_Width
Definition: lib_arc.h:50
Definition: colors.h:62

References _, BLUE, BROWN, GetBoundingBox(), EDA_RECT::GetEnd(), LIB_ITEM::GetMsgPanelInfo(), EDA_RECT::GetOrigin(), m_Width, MessageTextFromValue(), wxPoint::x, and wxPoint::y.

◆ GetParent()

◆ GetPenSize()

int LIB_ARC::GetPenSize ( ) const
overridevirtual
Returns
the size of the "pen" that be used to draw or plot this item

Implements LIB_ITEM.

Definition at line 286 of file lib_arc.cpp.

287 {
288  if( m_Width > 0 )
289  return m_Width;
290 
291  if( m_Width == 0 )
292  return GetDefaultLineThickness();
293 
294  return -1; // a value to use a minimal pen size
295 }
int GetDefaultLineThickness()
Default line thickness used to draw/plot items having a default thickness line value (i....
int m_Width
Definition: lib_arc.h:50

References GetDefaultLineThickness(), and m_Width.

Referenced by GetBoundingBox(), HitTest(), Plot(), and print().

◆ GetPosition()

wxPoint LIB_ARC::GetPosition ( ) const
inlineoverridevirtual

◆ GetRadius()

int LIB_ARC::GetRadius ( ) const
inline

Definition at line 105 of file lib_arc.h.

105 { return m_Radius; }
int m_Radius
Definition: lib_arc.h:44

References m_Radius.

Referenced by KIGFX::SCH_PAINTER::draw(), HitTest(), SCH_LEGACY_PLUGIN_CACHE::loadArc(), and SCH_LEGACY_PLUGIN_CACHE::saveArc().

◆ GetSecondRadiusAngle()

int LIB_ARC::GetSecondRadiusAngle ( ) const
inline

Definition at line 111 of file lib_arc.h.

111 { return m_t2; }
int m_t2
Definition: lib_arc.h:46

References m_t2.

Referenced by KIGFX::SCH_PAINTER::draw(), and SCH_LEGACY_PLUGIN_CACHE::saveArc().

◆ GetSelectMenuText()

wxString LIB_ARC::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 411 of file lib_arc.cpp.

412 {
413  return wxString::Format( _( "Arc center (%s, %s), radius %s" ),
414  MessageTextFromValue( aUnits, m_Pos.x ),
415  MessageTextFromValue( aUnits, m_Pos.y ),
416  MessageTextFromValue( aUnits, m_Radius ) );
417 }
int m_Radius
Definition: lib_arc.h:44
wxString MessageTextFromValue(EDA_UNITS aUnits, int aValue, bool aUseMils)
Definition: base_units.cpp:127
wxPoint m_Pos
Definition: lib_arc.h:49
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

References _, Format(), m_Pos, m_Radius, MessageTextFromValue(), wxPoint::x, and wxPoint::y.

◆ GetStart()

wxPoint LIB_ARC::GetStart ( ) const
inline

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

◆ GetTimeStamp()

◆ GetTypeName()

wxString LIB_ARC::GetTypeName ( )
inlineoverridevirtual

Provide a user-consumable name of the object type.

Perform localization when called so that run-time language selection works.

Implements LIB_ITEM.

Definition at line 68 of file lib_arc.h.

69  {
70  return _( "Arc" );
71  }
#define _(s)
Definition: 3d_actions.cpp:31

References _.

◆ GetUnit()

◆ GetWidth()

int LIB_ARC::GetWidth ( ) const
inlineoverridevirtual

Implements LIB_ITEM.

Definition at line 101 of file lib_arc.h.

101 { return m_Width; }
int m_Width
Definition: lib_arc.h:50

References m_Width.

Referenced by HitTest(), and SCH_LEGACY_PLUGIN_CACHE::saveArc().

◆ HasFlag()

◆ HitTest() [1/2]

bool LIB_ARC::HitTest ( const wxPoint aPosition,
int  aAccuracy = 0 
) 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 61 of file lib_arc.cpp.

62 {
63  int mindist = std::max( aAccuracy + GetPenSize() / 2,
64  Mils2iu( MINIMUM_SELECTION_DISTANCE ) );
65  wxPoint relativePosition = aRefPoint;
66 
67  relativePosition.y = -relativePosition.y; // reverse Y axis
68 
69  int distance = KiROUND( GetLineLength( m_Pos, relativePosition ) );
70 
71  if( abs( distance - m_Radius ) > mindist )
72  return false;
73 
74  // We are on the circle, ensure we are only on the arc, i.e. between
75  // m_ArcStart and m_ArcEnd
76 
77  wxPoint startEndVector = twoPointVector( m_ArcStart, m_ArcEnd);
78  wxPoint startRelativePositionVector = twoPointVector( m_ArcStart, relativePosition );
79 
80  wxPoint centerStartVector = twoPointVector( m_Pos, m_ArcStart );
81  wxPoint centerEndVector = twoPointVector( m_Pos, m_ArcEnd );
82  wxPoint centerRelativePositionVector = twoPointVector( m_Pos, relativePosition );
83 
84  // Compute the cross product to check if the point is in the sector
85  double crossProductStart = CrossProduct( centerStartVector, centerRelativePositionVector );
86  double crossProductEnd = CrossProduct( centerEndVector, centerRelativePositionVector );
87 
88  // The cross products need to be exchanged, depending on which side the center point
89  // relative to the start point to end point vector lies
90  if( CrossProduct( startEndVector, startRelativePositionVector ) < 0 )
91  {
92  std::swap( crossProductStart, crossProductEnd );
93  }
94 
95  // When the cross products have a different sign, the point lies in sector
96  // also check, if the reference is near start or end point
97  return HitTestPoints( m_ArcStart, relativePosition, MINIMUM_SELECTION_DISTANCE ) ||
98  HitTestPoints( m_ArcEnd, relativePosition, MINIMUM_SELECTION_DISTANCE ) ||
99  ( crossProductStart <= 0 && crossProductEnd >= 0 );
100 }
int m_Radius
Definition: lib_arc.h:44
static wxPoint twoPointVector(const wxPoint &startPoint, const wxPoint &endPoint)
Definition: lib_arc.cpp:43
double GetLineLength(const wxPoint &aPointA, const wxPoint &aPointB)
Function GetLineLength returns the length of a line segment defined by aPointA and aPointB.
Definition: trigo.h:202
wxPoint m_ArcEnd
Definition: lib_arc.h:48
wxPoint m_Pos
Definition: lib_arc.h:49
#define MINIMUM_SELECTION_DISTANCE
Definition: lib_item.h:46
double CrossProduct(const wxPoint &vectorA, const wxPoint &vectorB)
Determine the cross product.
Definition: trigo.h:177
int GetPenSize() const override
Definition: lib_arc.cpp:286
bool HitTestPoints(const wxPoint &pointA, const wxPoint &pointB, double threshold)
Test, if two points are near each other.
Definition: trigo.h:161
static float distance(const SFVEC2UI &a, const SFVEC2UI &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_ArcStart
Definition: lib_arc.h:47

References CrossProduct(), distance(), GetLineLength(), GetPenSize(), HitTestPoints(), KiROUND(), m_ArcEnd, m_ArcStart, m_Pos, m_Radius, MINIMUM_SELECTION_DISTANCE, twoPointVector(), and wxPoint::y.

◆ HitTest() [2/2]

bool LIB_ARC::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 103 of file lib_arc.cpp.

104 {
105  if( m_Flags & ( STRUCT_DELETED | SKIP_STRUCT ) )
106  return false;
107 
109  int radius = GetRadius();
110  int lineWidth = GetWidth();
111  EDA_RECT sel = aRect ;
112 
113  if ( aAccuracy )
114  sel.Inflate( aAccuracy );
115 
116  if( aContained )
117  return sel.Contains( GetBoundingBox() );
118 
119  EDA_RECT arcRect = GetBoundingBox().Common( sel );
120 
121  /* All following tests must pass:
122  * 1. Rectangle must intersect arc BoundingBox
123  * 2. Rectangle must cross the outside of the arc
124  */
125  return arcRect.Intersects( sel ) && arcRect.IntersectsCircleEdge( center, radius, lineWidth );
126 }
#define SKIP_STRUCT
flag indicating that the structure should be ignored
Definition: base_struct.h:131
const EDA_RECT GetBoundingBox() const override
Function GetBoundingBox returns the orthogonal, bounding box of this object for display purposes.
Definition: lib_arc.cpp:330
TRANSFORM DefaultTransform
bool IntersectsCircleEdge(const wxPoint &aCenter, const int aRadius, const int aWidth) const
IntersectsCircleEdge Tests for intersection between this rect and the edge (radius) of a circle.
EDA_RECT Common(const EDA_RECT &aRect) const
Function Common returns the area that is common with another rectangle.
bool Contains(const wxPoint &aPoint) const
Function Contains.
wxPoint TransformCoordinate(const wxPoint &aPoint) const
Calculate a new coordinate according to the mirror/rotation transform.
Definition: transform.cpp:42
#define STRUCT_DELETED
flag indication structures to be erased
Definition: base_struct.h:129
int GetRadius() const
Definition: lib_arc.h:105
int GetWidth() const override
Definition: lib_arc.h:101
STATUS_FLAGS m_Flags
Flag bits for editing and other uses.
Definition: base_struct.h:184
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.
wxPoint GetPosition() const override
Definition: lib_arc.h:92

References EDA_RECT::Common(), EDA_RECT::Contains(), DefaultTransform, GetBoundingBox(), GetPosition(), GetRadius(), GetWidth(), EDA_RECT::Inflate(), EDA_RECT::Intersects(), EDA_RECT::IntersectsCircleEdge(), EDA_ITEM::m_Flags, SKIP_STRUCT, STRUCT_DELETED, and TRANSFORM::TransformCoordinate().

◆ Inside()

bool LIB_ARC::Inside ( EDA_RECT aRect) const
overridevirtual

Test if any part of the draw object is inside rectangle bounds of aRect.

Parameters
aRectRectangle to check against.
Returns
True if object is inside rectangle.

Implements LIB_ITEM.

Definition at line 165 of file lib_arc.cpp.

166 {
167  return aRect.Contains( m_ArcStart.x, -m_ArcStart.y )
168  || aRect.Contains( m_ArcEnd.x, -m_ArcEnd.y );
169 }
wxPoint m_ArcEnd
Definition: lib_arc.h:48
bool Contains(const wxPoint &aPoint) const
Function Contains.
wxPoint m_ArcStart
Definition: lib_arc.h:47

References EDA_RECT::Contains(), m_ArcEnd, m_ArcStart, wxPoint::x, and wxPoint::y.

◆ IsBrightened()

bool EDA_ITEM::IsBrightened ( ) const
inlineinherited

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

◆ IsFillable()

bool LIB_ITEM::IsFillable ( ) const
inlineinherited

Check if draw object can be filled.

The default setting is false. If the derived object support filling, set the m_isFillable member to true.

Definition at line 295 of file lib_item.h.

295 { return m_isFillable; }
bool m_isFillable
Definition: lib_item.h:94

References LIB_ITEM::m_isFillable.

Referenced by LIB_EDIT_TOOL::editGraphicProperties(), and DIALOG_LIB_EDIT_DRAW_ITEM::TransferDataToWindow().

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

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

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

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

◆ MirrorHorizontal()

void LIB_ARC::MirrorHorizontal ( const wxPoint aCenter)
overridevirtual

Mirror the draw object along the horizontal (X) axis about aCenter point.

Parameters
aCenterPoint to mirror around.

Implements LIB_ITEM.

Definition at line 181 of file lib_arc.cpp.

182 {
183  m_Pos.x -= aCenter.x;
184  m_Pos.x *= -1;
185  m_Pos.x += aCenter.x;
186  m_ArcStart.x -= aCenter.x;
187  m_ArcStart.x *= -1;
188  m_ArcStart.x += aCenter.x;
189  m_ArcEnd.x -= aCenter.x;
190  m_ArcEnd.x *= -1;
191  m_ArcEnd.x += aCenter.x;
192  std::swap( m_ArcStart, m_ArcEnd );
193  std::swap( m_t1, m_t2 );
194  m_t1 = 1800 - m_t1;
195  m_t2 = 1800 - m_t2;
196  if( m_t1 > 3600 || m_t2 > 3600 )
197  {
198  m_t1 -= 3600;
199  m_t2 -= 3600;
200  }
201  else if( m_t1 < -3600 || m_t2 < -3600 )
202  {
203  m_t1 += 3600;
204  m_t2 += 3600;
205  }
206 }
int m_t1
Definition: lib_arc.h:45
int m_t2
Definition: lib_arc.h:46
wxPoint m_ArcEnd
Definition: lib_arc.h:48
wxPoint m_Pos
Definition: lib_arc.h:49
wxPoint m_ArcStart
Definition: lib_arc.h:47

References m_ArcEnd, m_ArcStart, m_Pos, m_t1, m_t2, and wxPoint::x.

◆ MirrorVertical()

void LIB_ARC::MirrorVertical ( const wxPoint aCenter)
overridevirtual

Mirror the draw object along the MirrorVertical (Y) axis about aCenter point.

Parameters
aCenterPoint to mirror around.

Implements LIB_ITEM.

Definition at line 208 of file lib_arc.cpp.

209 {
210  m_Pos.y -= aCenter.y;
211  m_Pos.y *= -1;
212  m_Pos.y += aCenter.y;
213  m_ArcStart.y -= aCenter.y;
214  m_ArcStart.y *= -1;
215  m_ArcStart.y += aCenter.y;
216  m_ArcEnd.y -= aCenter.y;
217  m_ArcEnd.y *= -1;
218  m_ArcEnd.y += aCenter.y;
219  std::swap( m_ArcStart, m_ArcEnd );
220  std::swap( m_t1, m_t2 );
221  m_t1 = - m_t1;
222  m_t2 = - m_t2;
223  if( m_t1 > 3600 || m_t2 > 3600 )
224  {
225  m_t1 -= 3600;
226  m_t2 -= 3600;
227  }
228  else if( m_t1 < -3600 || m_t2 < -3600 )
229  {
230  m_t1 += 3600;
231  m_t2 += 3600;
232  }
233 }
int m_t1
Definition: lib_arc.h:45
int m_t2
Definition: lib_arc.h:46
wxPoint m_ArcEnd
Definition: lib_arc.h:48
wxPoint m_Pos
Definition: lib_arc.h:49
wxPoint m_ArcStart
Definition: lib_arc.h:47

References m_ArcEnd, m_ArcStart, m_Pos, m_t1, m_t2, and wxPoint::y.

◆ MoveTo()

void LIB_ARC::MoveTo ( const wxPoint aPosition)
overridevirtual

Move a draw object to aPosition.

Parameters
aPositionPosition to move draw item to.

Implements LIB_ITEM.

Definition at line 172 of file lib_arc.cpp.

173 {
174  wxPoint offset = aPosition - m_Pos;
175  m_Pos = aPosition;
176  m_ArcStart += offset;
177  m_ArcEnd += offset;
178 }
wxPoint m_ArcEnd
Definition: lib_arc.h:48
wxPoint m_Pos
Definition: lib_arc.h:49
wxPoint m_ArcStart
Definition: lib_arc.h:47

References m_ArcEnd, m_ArcStart, and m_Pos.

◆ Offset()

void LIB_ARC::Offset ( const wxPoint aOffset)
overridevirtual

Set the drawing object by aOffset from the current position.

Parameters
aOffsetCoordinates to offset the item position.

Implements LIB_ITEM.

Definition at line 157 of file lib_arc.cpp.

158 {
159  m_Pos += aOffset;
160  m_ArcStart += aOffset;
161  m_ArcEnd += aOffset;
162 }
wxPoint m_ArcEnd
Definition: lib_arc.h:48
wxPoint m_Pos
Definition: lib_arc.h:49
wxPoint m_ArcStart
Definition: lib_arc.h:47

References m_ArcEnd, m_ArcStart, and m_Pos.

◆ operator<() [1/2]

bool LIB_ITEM::operator< ( const LIB_ITEM aOther) const
inherited

Test if another draw item is less than this draw object.

Parameters
aOther- Draw item to compare against.
Returns
- True if object is less than this object.

Definition at line 85 of file lib_item.cpp.

86 {
87  int result = m_Convert - aOther.m_Convert;
88 
89  if( result != 0 )
90  return result < 0;
91 
92  result = m_Unit - aOther.m_Unit;
93 
94  if( result != 0 )
95  return result < 0;
96 
97  result = Type() - aOther.Type();
98 
99  if( result != 0 )
100  return result < 0;
101 
102  return ( compare( aOther ) < 0 );
103 }
int m_Unit
Unit identification for multiple parts per package.
Definition: lib_item.h:81
virtual int compare(const LIB_ITEM &aOther) const =0
Provide the draw object specific comparison called by the == and < operators.
int m_Convert
Shape identification for alternate body styles.
Definition: lib_item.h:87
KICAD_T Type() const
Function Type()
Definition: base_struct.h:207

References LIB_ITEM::compare(), LIB_ITEM::m_Convert, LIB_ITEM::m_Unit, and EDA_ITEM::Type().

◆ operator<() [2/2]

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

◆ operator==() [1/2]

bool LIB_ITEM::operator== ( const LIB_ITEM aOther) const
inherited

Test LIB_ITEM objects for equivalence.

Parameters
aOtherObject to test against.
Returns
True if object is identical to this object.

Definition at line 76 of file lib_item.cpp.

77 {
78  return ( ( Type() == aOther.Type() )
79  && ( m_Unit == aOther.m_Unit )
80  && ( m_Convert == aOther.m_Convert )
81  && compare( aOther ) == 0 );
82 }
int m_Unit
Unit identification for multiple parts per package.
Definition: lib_item.h:81
virtual int compare(const LIB_ITEM &aOther) const =0
Provide the draw object specific comparison called by the == and < operators.
int m_Convert
Shape identification for alternate body styles.
Definition: lib_item.h:87
KICAD_T Type() const
Function Type()
Definition: base_struct.h:207

References LIB_ITEM::compare(), LIB_ITEM::m_Convert, LIB_ITEM::m_Unit, and EDA_ITEM::Type().

◆ operator==() [2/2]

bool LIB_ITEM::operator== ( const LIB_ITEM aOther) const
inlineinherited

Definition at line 215 of file lib_item.h.

216  {
217  return *this == *aOther;
218  }

◆ Plot()

void LIB_ARC::Plot ( PLOTTER aPlotter,
const wxPoint aOffset,
bool  aFill,
const TRANSFORM aTransform 
)
overridevirtual

Plot the draw item using the plot object.

Parameters
aPlotterThe plot object to plot to.
aOffsetPlot offset position.
aFillFlag to indicate whether or not the object is filled.
aTransformThe plot transform.

Implements LIB_ITEM.

Definition at line 257 of file lib_arc.cpp.

259 {
260  wxASSERT( aPlotter != NULL );
261 
262  int t1 = m_t1;
263  int t2 = m_t2;
264  wxPoint pos = aTransform.TransformCoordinate( m_Pos ) + aOffset;
265 
266  aTransform.MapAngles( &t1, &t2 );
267 
268  if( aFill && m_Fill == FILLED_WITH_BG_BODYCOLOR )
269  {
271  aPlotter->Arc( pos, -t2, -t1, m_Radius, FILLED_WITH_BG_BODYCOLOR, 0 );
272  }
273 
274  bool already_filled = m_Fill == FILLED_WITH_BG_BODYCOLOR;
275  auto pen_size = GetPenSize();
276 
277  if( !already_filled || pen_size > 0 )
278  {
279  pen_size = std::max( 0, pen_size );
280  aPlotter->SetColor( GetLayerColor( LAYER_DEVICE ) );
281  aPlotter->Arc( pos, -t2, -t1, m_Radius, already_filled ? NO_FILL : m_Fill, pen_size );
282  }
283 }
int m_Radius
Definition: lib_arc.h:44
int m_t1
Definition: lib_arc.h:45
virtual void SetColor(COLOR4D color)=0
int m_t2
Definition: lib_arc.h:46
COLOR4D GetLayerColor(SCH_LAYER_ID aLayer)
wxPoint TransformCoordinate(const wxPoint &aPoint) const
Calculate a new coordinate according to the mirror/rotation transform.
Definition: transform.cpp:42
#define NULL
wxPoint m_Pos
Definition: lib_arc.h:49
int GetPenSize() const override
Definition: lib_arc.cpp:286
FILL_T m_Fill
The body fill type.
Definition: lib_item.h:93
virtual void Arc(const wxPoint &centre, double StAngle, double EndAngle, int rayon, FILL_T fill, int width=USE_DEFAULT_LINE_WIDTH)
Generic fallback: arc rendered as a polyline.
Definition: plotter.cpp:157
bool MapAngles(int *aAngle1, int *aAngle2) const
Calculate new angles according to the transform.
Definition: transform.cpp:81

References PLOTTER::Arc(), FILLED_WITH_BG_BODYCOLOR, GetLayerColor(), GetPenSize(), LAYER_DEVICE, LAYER_DEVICE_BACKGROUND, LIB_ITEM::m_Fill, m_Pos, m_Radius, m_t1, m_t2, TRANSFORM::MapAngles(), NO_FILL, NULL, PLOTTER::SetColor(), and TRANSFORM::TransformCoordinate().

◆ print()

void LIB_ARC::print ( wxDC *  aDC,
const wxPoint aOffset,
void *  aData,
const TRANSFORM aTransform 
)
overrideprivatevirtual

Print the item to aDC.

Parameters
aDCA pointer to the device context used to draw the object.
aOffsetA reference to a wxPoint object containing the offset where to draw from the object's current position.
aDataA pointer to any object specific data required to perform the draw.
aTransformA reference to a TRANSFORM object containing drawing transform.

Implements LIB_ITEM.

Definition at line 298 of file lib_arc.cpp.

299 {
300  wxPoint pos1, pos2, posc;
303 
304  pos1 = aTransform.TransformCoordinate( m_ArcEnd ) + aOffset;
305  pos2 = aTransform.TransformCoordinate( m_ArcStart ) + aOffset;
306  posc = aTransform.TransformCoordinate( m_Pos ) + aOffset;
307  int pt1 = m_t1;
308  int pt2 = m_t2;
309  bool swap = aTransform.MapAngles( &pt1, &pt2 );
310 
311  if( swap )
312  {
313  std::swap( pos1.x, pos2.x );
314  std::swap( pos1.y, pos2.y );
315  }
316 
317  FILL_T fill = aData ? NO_FILL : m_Fill;
318 
319  int penSize = GetPenSize();
320 
321  if( fill == FILLED_WITH_BG_BODYCOLOR )
322  GRFilledArc( nullptr, aDC, posc.x, posc.y, pt1, pt2, m_Radius, penSize, bgColor, bgColor );
323  else if( fill == FILLED_SHAPE && !aData )
324  GRFilledArc( nullptr, aDC, posc.x, posc.y, pt1, pt2, m_Radius, color, color );
325  else
326  GRArc1( nullptr, aDC, pos1.x, pos1.y, pos2.x, pos2.y, posc.x, posc.y, penSize, color );
327 }
int m_Radius
Definition: lib_arc.h:44
int m_t1
Definition: lib_arc.h:45
int m_t2
Definition: lib_arc.h:46
int color
Definition: DXF_plotter.cpp:61
wxPoint m_ArcEnd
Definition: lib_arc.h:48
COLOR4D GetLayerColor(SCH_LAYER_ID aLayer)
wxPoint TransformCoordinate(const wxPoint &aPoint) const
Calculate a new coordinate according to the mirror/rotation transform.
Definition: transform.cpp:42
wxPoint m_Pos
Definition: lib_arc.h:49
int GetPenSize() const override
Definition: lib_arc.cpp:286
void GRFilledArc(EDA_RECT *ClipBox, wxDC *DC, int x, int y, double StAngle, double EndAngle, int r, int width, COLOR4D Color, COLOR4D BgColor)
Definition: gr_basic.cpp:689
FILL_T m_Fill
The body fill type.
Definition: lib_item.h:93
FILL_T
Enum FILL_T is the set of fill types used in plotting or drawing enclosed areas.
Definition: base_struct.h:42
bool MapAngles(int *aAngle1, int *aAngle2) const
Calculate new angles according to the transform.
Definition: transform.cpp:81
wxPoint m_ArcStart
Definition: lib_arc.h:47
void GRArc1(EDA_RECT *ClipBox, wxDC *DC, int x1, int y1, int x2, int y2, int xc, int yc, COLOR4D Color)
Definition: gr_basic.cpp:640
COLOR4D is the color representation with 4 components: red, green, blue, alpha.
Definition: color4d.h:39

References color, FILLED_SHAPE, FILLED_WITH_BG_BODYCOLOR, GetLayerColor(), GetPenSize(), GRArc1(), GRFilledArc(), LAYER_DEVICE, LAYER_DEVICE_BACKGROUND, m_ArcEnd, m_ArcStart, LIB_ITEM::m_Fill, m_Pos, m_Radius, m_t1, m_t2, TRANSFORM::MapAngles(), NO_FILL, TRANSFORM::TransformCoordinate(), wxPoint::x, and wxPoint::y.

◆ Print()

void LIB_ITEM::Print ( wxDC *  aDC,
const wxPoint aOffset,
void *  aData,
const TRANSFORM aTransform 
)
virtualinherited

Draw an item.

Parameters
aDCDevice Context (can be null)
aOffsetOffset to draw
aDataValue or pointer used to pass others parameters, depending on body items. Used for some items to force to force no fill mode ( has meaning only for items what can be filled ). used in printing or moving objects mode or to pass reference to the lib component for pins.
aTransformTransform Matrix (rotation, mirror ..)

Definition at line 123 of file lib_item.cpp.

124 {
125  print( aDC, aOffset, aData, aTransform );
126 }
virtual void print(wxDC *aDC, const wxPoint &aOffset, void *aData, const TRANSFORM &aTransform)=0
Print the item to aDC.

References LIB_ITEM::print().

Referenced by DIALOG_LIB_EDIT_PIN::OnPaintShowPanel().

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

void LIB_ARC::Rotate ( const wxPoint aCenter,
bool  aRotateCCW = true 
)
overridevirtual

Rotate the object about aCenter point.

Parameters
aCenterPoint to rotate around.
aRotateCCWTrue to rotate counter clockwise. False to rotate clockwise.

Implements LIB_ITEM.

Definition at line 235 of file lib_arc.cpp.

236 {
237  int rot_angle = aRotateCCW ? -900 : 900;
238  RotatePoint( &m_Pos, aCenter, rot_angle );
239  RotatePoint( &m_ArcStart, aCenter, rot_angle );
240  RotatePoint( &m_ArcEnd, aCenter, rot_angle );
241  m_t1 -= rot_angle;
242  m_t2 -= rot_angle;
243  if( m_t1 > 3600 || m_t2 > 3600 )
244  {
245  m_t1 -= 3600;
246  m_t2 -= 3600;
247  }
248  else if( m_t1 < -3600 || m_t2 < -3600 )
249  {
250  m_t1 += 3600;
251  m_t2 += 3600;
252  }
253 }
int m_t1
Definition: lib_arc.h:45
int m_t2
Definition: lib_arc.h:46
wxPoint m_ArcEnd
Definition: lib_arc.h:48
void RotatePoint(int *pX, int *pY, double angle)
Definition: trigo.cpp:208
wxPoint m_Pos
Definition: lib_arc.h:49
wxPoint m_ArcStart
Definition: lib_arc.h:47

References m_ArcEnd, m_ArcStart, m_Pos, m_t1, m_t2, and RotatePoint().

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

◆ SetConvert()

◆ SetEditState()

void LIB_ARC::SetEditState ( int  aState)
inline

Definition at line 84 of file lib_arc.h.

84 { m_editState = aState; }
int m_editState
Definition: lib_arc.h:51

References m_editState.

Referenced by EE_POINT_EDITOR::updateItem().

◆ SetEnd()

void LIB_ARC::SetEnd ( const wxPoint aPoint)
inline

Definition at line 117 of file lib_arc.h.

117 { m_ArcEnd = aPoint; }
wxPoint m_ArcEnd
Definition: lib_arc.h:48

References m_ArcEnd.

Referenced by KIGFX::SCH_PAINTER::draw(), and SCH_LEGACY_PLUGIN_CACHE::loadArc().

◆ SetFillMode()

◆ SetFirstRadiusAngle()

void LIB_ARC::SetFirstRadiusAngle ( int  aAngle)
inline

Definition at line 107 of file lib_arc.h.

107 { m_t1 = aAngle; }
int m_t1
Definition: lib_arc.h:45

References m_t1.

Referenced by SCH_LEGACY_PLUGIN_CACHE::loadArc().

◆ 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.

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

◆ SetModified()

◆ SetParent()

◆ SetPosition()

◆ SetRadius()

void LIB_ARC::SetRadius ( int  aRadius)
inline

Definition at line 104 of file lib_arc.h.

104 { m_Radius = aRadius; }
int m_Radius
Definition: lib_arc.h:44

References m_Radius.

Referenced by SCH_LEGACY_PLUGIN_CACHE::loadArc().

◆ SetSecondRadiusAngle()

void LIB_ARC::SetSecondRadiusAngle ( int  aAngle)
inline

Definition at line 110 of file lib_arc.h.

110 { m_t2 = aAngle; }
int m_t2
Definition: lib_arc.h:46

References m_t2.

Referenced by SCH_LEGACY_PLUGIN_CACHE::loadArc().

◆ SetSelected()

void EDA_ITEM::SetSelected ( )
inlineinherited

◆ SetStart()

void LIB_ARC::SetStart ( const wxPoint aPoint)
inline

Definition at line 114 of file lib_arc.h.

114 { m_ArcStart = aPoint; }
wxPoint m_ArcStart
Definition: lib_arc.h:47

References m_ArcStart.

Referenced by KIGFX::SCH_PAINTER::draw(), and SCH_LEGACY_PLUGIN_CACHE::loadArc().

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

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

◆ SetUnit()

◆ SetWidth()

void LIB_ARC::SetWidth ( int  aWidth)
inlineoverridevirtual

Implements LIB_ITEM.

Definition at line 102 of file lib_arc.h.

102 { m_Width = aWidth; }
int m_Width
Definition: lib_arc.h:50

References m_Width.

Referenced by SCH_LEGACY_PLUGIN_CACHE::loadArc().

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

◆ 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; }

◆ 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(), DIMENSION::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(), 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(), DIMENSION::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().

◆ ViewBBox()

const BOX2I EDA_ITEM::ViewBBox ( ) const
overridevirtualinherited

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

Returns
BOX2I - the current bounding box

Implements KIGFX::VIEW_ITEM.

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

Definition at line 231 of file base_struct.cpp.

232 {
233  // Basic fallback
234  return BOX2I( VECTOR2I( GetBoundingBox().GetOrigin() ),
235  VECTOR2I( GetBoundingBox().GetSize() ) );
236 }
BOX2< VECTOR2I > BOX2I
Definition: box2.h:521
VECTOR2< int > VECTOR2I
Definition: vector2d.h:594
virtual const EDA_RECT GetBoundingBox() const
Function GetBoundingBox returns the orthogonal, bounding box of this object for display purposes.

References EDA_ITEM::GetBoundingBox().

Referenced by GERBVIEW_FRAME::GetDocumentExtents(), BRIGHT_BOX::ViewBBox(), DIMENSION::ViewBBox(), DRAWSEGMENT::ViewBBox(), and BRIGHT_BOX::ViewDraw().

◆ 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 LIB_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 LIB_TEXT.

Definition at line 129 of file lib_item.cpp.

130 {
131  // Basic fallback
132  aCount = 3;
133  aLayers[0] = LAYER_DEVICE;
134  aLayers[1] = LAYER_DEVICE_BACKGROUND;
135  aLayers[2] = LAYER_SELECTION_SHADOWS;
136 }

References LAYER_DEVICE, LAYER_DEVICE_BACKGROUND, and LAYER_SELECTION_SHADOWS.

◆ 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_ArcEnd

◆ m_ArcStart

◆ m_Convert

int LIB_ITEM::m_Convert
protectedinherited

Shape identification for alternate body styles.

Set 0 if the item is common to all body styles. This is typially used for representing DeMorgan variants in KiCad.

Definition at line 87 of file lib_item.h.

Referenced by LIB_TEXT::Clone(), LIB_ITEM::GetConvert(), LIB_ITEM::GetMsgPanelInfo(), LIB_ITEM::LIB_ITEM(), SCH_LEGACY_PLUGIN_CACHE::loadPin(), LIB_ITEM::operator<(), LIB_ITEM::operator==(), LIB_PIN::SetConversion(), LIB_PART::SetConversion(), LIB_ITEM::SetConvert(), LIB_PIN::SetLength(), LIB_PIN::SetPartNumber(), LIB_PIN::SetPinPosition(), and LIB_PIN::SetShape().

◆ m_editState

int LIB_ARC::m_editState
private

Definition at line 51 of file lib_arc.h.

Referenced by BeginEdit(), CalcEdit(), LIB_ARC(), and SetEditState().

◆ m_Fill

◆ 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_isFillable

◆ m_Parent

◆ m_Pos

◆ m_Radius

int LIB_ARC::m_Radius
private

◆ m_t1

◆ m_t2

◆ m_TimeStamp

timestamp_t EDA_ITEM::m_TimeStamp
protectedinherited

◆ m_Unit

int LIB_ITEM::m_Unit
protectedinherited

◆ m_Width

int LIB_ARC::m_Width
private

Definition at line 50 of file lib_arc.h.

Referenced by GetMsgPanelInfo(), GetPenSize(), GetWidth(), LIB_ARC(), and SetWidth().


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