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 }
 
enum  COMPARE_FLAGS : int { NORMAL = 0x00, UNIT = 0x01 }
 The list of flags used by the compare function. More...
 

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_DRAW_FRAME *aFrame, 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 GetPenWidth () 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...
 
void MoveTo (const wxPoint &aPosition) override
 Move a draw object to aPosition. More...
 
const 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)
 
VECTOR2I CalcMidPoint () const
 Calculate the arc mid point using the arc start and end angles and radius length. More...
 
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 (RENDER_SETTINGS *aSettings, 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...
 
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...
 
virtual void SetParent (EDA_ITEM *aParent)
 
bool IsModified () const
 
bool IsNew () 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...
 
bool IsForceVisible () const
 
virtual const wxPoint GetFocusPosition () const
 Function GetFocusPosition similar to GetPosition, but allows items to return their visual center rather than their anchor. 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...
 

Public Attributes

const KIID m_Uuid
 

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
 
STATUS_FLAGS m_Status
 
EDA_ITEMm_Parent
 Linked list: Link (parent struct) More...
 
bool m_forceVisible
 
STATUS_FLAGS m_Flags
 

Private Types

enum  SELECT_T { ARC_STATUS_START, ARC_STATUS_END, ARC_STATUS_OUTLINE }
 

Private Member Functions

void print (RENDER_SETTINGS *aSettings, const wxPoint &aOffset, void *aData, const TRANSFORM &aTransform) override
 Print the item to aDC. More...
 
int compare (const LIB_ITEM &aOther, LIB_ITEM::COMPARE_FLAGS aCompareFlags=LIB_ITEM::COMPARE_FLAGS::NORMAL) 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

◆ COMPARE_FLAGS

enum LIB_ITEM::COMPARE_FLAGS : int
inherited

The list of flags used by the compare function.

  • NORMAL This compares everthing between two LIB_ITEM objects.
  • UNIT This compare flag ignores unit and convert and pin number information when comparing LIB_ITEM objects for unit comparison.
Enumerator
NORMAL 
UNIT 

Definition at line 116 of file lib_item.h.

116 : int { NORMAL = 0x00, UNIT = 0x01 };

◆ 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 50 of file lib_arc.cpp.

50  : LIB_ITEM( LIB_ARC_T, aParent )
51 {
52  m_Radius = 0;
53  m_t1 = 0;
54  m_t2 = 0;
55  m_Width = 0;
56  m_Fill = NO_FILL;
57  m_isFillable = true;
58  m_editState = 0;
59 }
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 434 of file lib_arc.cpp.

435 {
436  m_ArcStart = m_ArcEnd = aPosition;
437  m_editState = 1;
438 }
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 441 of file lib_arc.cpp.

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

◆ CalcMidPoint()

VECTOR2I LIB_ARC::CalcMidPoint ( ) const

Calculate the arc mid point using the arc start and end angles and radius length.

Note
This is not a general purpose trigonometric arc midpoint calculation. It is limited to the less than 180.0 degree arcs used in symbols.
Returns
A VECTOR2I object containing the midpoint of the arc.

Definition at line 587 of file lib_arc.cpp.

588 {
589  VECTOR2D midPoint;
590  double startAngle = static_cast<double>( m_t1 ) / 10.0;
591  double endAngle = static_cast<double>( m_t2 ) / 10.0;
592 
593  if( endAngle < startAngle )
594  endAngle -= 360.0;
595 
596  double midPointAngle = ( ( endAngle - startAngle ) / 2.0 ) + startAngle;
597  double x = cos( DEG2RAD( midPointAngle ) ) * m_Radius;
598  double y = sin( DEG2RAD( midPointAngle ) ) * m_Radius;
599 
600  midPoint.x = KiROUND( x ) + m_Pos.x;
601  midPoint.y = KiROUND( y ) + m_Pos.y;
602 
603  return midPoint;
604 }
int m_Radius
Definition: lib_arc.h:44
int m_t1
Definition: lib_arc.h:45
int m_t2
Definition: lib_arc.h:46
wxPoint m_Pos
Definition: lib_arc.h:49
double DEG2RAD(double deg)
Definition: trigo.h:214
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

References DEG2RAD(), KiROUND(), m_Pos, m_Radius, m_t1, m_t2, wxPoint::x, VECTOR2< T >::x, wxPoint::y, and VECTOR2< T >::y.

◆ CalcRadiusAngles()

void LIB_ARC::CalcRadiusAngles ( )

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

Definition at line 547 of file lib_arc.cpp.

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

◆ ClearEditFlags()

◆ ClearFlags()

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

Definition at line 240 of file base_struct.h.

240 { m_Flags &= ~aMask; }
STATUS_FLAGS m_Flags
Definition: base_struct.h:180

References EDA_ITEM::m_Flags.

Referenced by FOOTPRINT_VIEWER_FRAME::AddFootprintToPCB(), PNS_KICAD_IFACE::AddItem(), SCH_EDIT_FRAME::AddItemToScreenAndUndoList(), SCH_COMPONENT::ClearAllHighlightFlags(), SCH_SCREEN::ClearAnnotation(), EDA_ITEM::ClearBrightened(), EDA_ITEM::ClearEditFlags(), EDA_ITEM::ClearHighlighted(), clearModuleItemFlags(), EDA_ITEM::ClearSelected(), EDA_ITEM::ClearTempFlags(), SCH_EDIT_FRAME::ConvertPart(), LIB_EDIT_TOOL::Copy(), MICROWAVE_TOOL::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(), FOOTPRINT_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_SEXPR_PLUGIN_CACHE::savePin(), 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 218 of file base_struct.h.

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

References EDA_ITEM::ClearFlags(), and HIGHLIGHTED.

◆ ClearSelected()

◆ ClearTempFlags()

void EDA_ITEM::ClearTempFlags ( )
inlineinherited

Definition at line 252 of file base_struct.h.

253  {
255  DO_NOT_DRAW | FLAG0 | FLAG1 | BUSY );
256  }
#define IS_LINKED
Used in calculation to mark linked items (temporary use)
Definition: base_struct.h:114
#define FLAG1
Pcbnew: flag used in local computations.
Definition: base_struct.h:133
#define TEMP_SELECTED
flag indicating that the structure has already selected
Definition: base_struct.h:125
#define SKIP_STRUCT
flag indicating that the structure should be ignored
Definition: base_struct.h:128
#define BUSY
Pcbnew: flag indicating that the structure has.
Definition: base_struct.h:137
#define CANDIDATE
flag indicating that the structure is connected
Definition: base_struct.h:127
#define FLAG0
Pcbnew: flag used in local computations.
Definition: base_struct.h:134
#define ENDPOINT
ends. (Used to support dragging.)
Definition: base_struct.h:123
void ClearFlags(STATUS_FLAGS aMask=EDA_ITEM_ALL_FLAGS)
Definition: base_struct.h:240
#define DO_NOT_DRAW
Used to disable draw function.
Definition: base_struct.h:129
#define STARTPOINT
When a line is selected, these flags indicate which.
Definition: base_struct.h:122

References BUSY, CANDIDATE, EDA_ITEM::ClearFlags(), DO_NOT_DRAW, ENDPOINT, FLAG0, FLAG1, IS_LINKED, SKIP_STRUCT, STARTPOINT, and TEMP_SELECTED.

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 130 of file lib_arc.cpp.

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

References LIB_ARC().

◆ compare()

int LIB_ARC::compare ( const LIB_ITEM aOther,
LIB_ITEM::COMPARE_FLAGS  aCompareFlags = LIB_ITEM::COMPARE_FLAGS::NORMAL 
) 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.
Note
Make sure you call down to LIB_ITEM::compare before doing any derived object comparisons or you will break the sorting using the symbol library file format.
Parameters
aOtherA reference to the other LIB_ITEM to compare the arc against.
aCompareFlagsThe flags used to perform the comparison.
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.

Reimplemented from LIB_ITEM.

Definition at line 136 of file lib_arc.cpp.

137 {
138  wxASSERT( aOther.Type() == LIB_ARC_T );
139 
140  int retv = LIB_ITEM::compare( aOther );
141 
142  if( retv )
143  return retv;
144 
145  const LIB_ARC* tmp = ( LIB_ARC* ) &aOther;
146 
147  if( m_Pos.x != tmp->m_Pos.x )
148  return m_Pos.x - tmp->m_Pos.x;
149 
150  if( m_Pos.y != tmp->m_Pos.y )
151  return m_Pos.y - tmp->m_Pos.y;
152 
153  if( m_t1 != tmp->m_t1 )
154  return m_t1 - tmp->m_t1;
155 
156  if( m_t2 != tmp->m_t2 )
157  return m_t2 - tmp->m_t2;
158 
159  return 0;
160 }
int m_t1
Definition: lib_arc.h:45
int m_t2
Definition: lib_arc.h:46
wxPoint m_Pos
Definition: lib_arc.h:49
virtual int compare(const LIB_ITEM &aOther, LIB_ITEM::COMPARE_FLAGS aCompareFlags=LIB_ITEM::COMPARE_FLAGS::NORMAL) const
Provide the draw object specific comparison called by the == and < operators.
Definition: lib_item.cpp:76
KICAD_T Type() const
Function Type()
Definition: base_struct.h:197

References LIB_ITEM::compare(), 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 145 of file lib_item.h.

145 { 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 152 of file lib_item.h.

152 {}

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 338 of file lib_arc.cpp.

339 {
340  int minX, minY, maxX, maxY, angleStart, angleEnd;
341  EDA_RECT rect;
342  wxPoint nullPoint, startPos, endPos, centerPos;
343  wxPoint normStart = m_ArcStart - m_Pos;
344  wxPoint normEnd = m_ArcEnd - m_Pos;
345 
346  if( ( normStart == nullPoint ) || ( normEnd == nullPoint ) || ( m_Radius == 0 ) )
347  {
348  wxLogDebug( wxT("Invalid arc drawing definition, center(%d, %d), start(%d, %d), "
349  "end(%d, %d), radius %d" ),
351  m_ArcEnd.y, m_Radius );
352  return rect;
353  }
354 
358  angleStart = m_t1;
359  angleEnd = m_t2;
360 
361  if( DefaultTransform.MapAngles( &angleStart, &angleEnd ) )
362  {
363  std::swap( endPos.x, startPos.x );
364  std::swap( endPos.y, startPos.y );
365  }
366 
367  /* Start with the start and end point of the arc. */
368  minX = std::min( startPos.x, endPos.x );
369  minY = std::min( startPos.y, endPos.y );
370  maxX = std::max( startPos.x, endPos.x );
371  maxY = std::max( startPos.y, endPos.y );
372 
373  /* Zero degrees is a special case. */
374  if( angleStart == 0 )
375  maxX = centerPos.x + m_Radius;
376 
377  /* Arc end angle wrapped passed 360. */
378  if( angleStart > angleEnd )
379  angleEnd += 3600;
380 
381  if( angleStart <= 900 && angleEnd >= 900 ) /* 90 deg */
382  maxY = centerPos.y + m_Radius;
383 
384  if( angleStart <= 1800 && angleEnd >= 1800 ) /* 180 deg */
385  minX = centerPos.x - m_Radius;
386 
387  if( angleStart <= 2700 && angleEnd >= 2700 ) /* 270 deg */
388  minY = centerPos.y - m_Radius;
389 
390  if( angleStart <= 3600 && angleEnd >= 3600 ) /* 0 deg */
391  maxX = centerPos.x + m_Radius;
392 
393  rect.SetOrigin( minX, minY );
394  rect.SetEnd( maxX, maxY );
395  rect.Inflate( ( GetPenWidth() / 2 ) + 1 );
396 
397  return rect;
398 }
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 GetPenWidth() 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, GetPenWidth(), 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()

◆ GetEditFlags()

STATUS_FLAGS EDA_ITEM::GetEditFlags ( ) const
inlineinherited

Definition at line 244 of file base_struct.h.

245  {
246  constexpr int mask = ( IS_NEW | IS_PASTED | IS_MOVED | IS_RESIZED | IS_DRAGGED |
248 
249  return m_Flags & mask;
250  }
#define IS_NEW
New item, just created.
Definition: base_struct.h:117
#define IS_DRAGGED
Item being dragged.
Definition: base_struct.h:119
#define STRUCT_DELETED
flag indication structures to be erased
Definition: base_struct.h:126
#define IS_WIRE_IMAGE
Item to be drawn as wireframe while editing.
Definition: base_struct.h:121
STATUS_FLAGS m_Flags
Definition: base_struct.h:180
#define IS_RESIZED
Item being resized.
Definition: base_struct.h:118
#define IS_PASTED
Modifier on IS_NEW which indicates it came from clipboard.
Definition: base_struct.h:130
#define IS_MOVED
Item being moved.
Definition: base_struct.h:116

References IS_DRAGGED, IS_MOVED, IS_NEW, IS_PASTED, IS_RESIZED, IS_WIRE_IMAGE, EDA_ITEM::m_Flags, and STRUCT_DELETED.

Referenced by SCH_EDIT_TOOL::ChangeShape(), SCH_EDIT_TOOL::ChangeTextType(), EDA_ITEM::ClearEditFlags(), SCH_EDIT_FRAME::DeleteJunction(), SCH_EDIT_TOOL::editFieldText(), SCH_EDITOR_CONTROL::EditWithLibEdit(), SCH_COMPONENT::GetMsgPanelInfo(), 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_EDIT_COMPONENT_IN_SCHEMATIC::TransferDataFromWindow(), DIALOG_TEXT_PROPERTIES::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 106 of file lib_arc.h.

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

References m_t1.

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

◆ GetFlags()

◆ GetFocusPosition()

virtual const wxPoint EDA_ITEM::GetFocusPosition ( ) const
inlinevirtualinherited

Function GetFocusPosition similar to GetPosition, but allows items to return their visual center rather than their anchor.

Reimplemented in TRACK.

Definition at line 351 of file base_struct.h.

351 { return GetPosition(); }
virtual const wxPoint GetPosition() const
Definition: base_struct.h:344

References EDA_ITEM::GetPosition().

Referenced by PCB_BASE_FRAME::FocusOnItem(), and SCH_EDIT_FRAME::FocusOnItem().

◆ 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 428 of file lib_arc.cpp.

429 {
430  return add_arc_xpm;
431 }
const BITMAP_OPAQUE add_arc_xpm[1]
Definition: add_arc.cpp:37

References add_arc_xpm.

◆ GetMsgPanelInfo()

void LIB_ARC::GetMsgPanelInfo ( EDA_DRAW_FRAME aFrame,
std::vector< MSG_PANEL_ITEM > &  aList 
)
overridevirtual

Function GetMsgPanelInfo populates aList of MSG_PANEL_ITEM objects with it's internal state for display purposes.

Parameters
aListis the list to populate.

Reimplemented from EDA_ITEM.

Definition at line 401 of file lib_arc.cpp.

402 {
403  wxString msg;
404  EDA_RECT bBox = GetBoundingBox();
405 
406  LIB_ITEM::GetMsgPanelInfo( aFrame, aList );
407 
408  msg = MessageTextFromValue( aFrame->GetUserUnits(), m_Width, true );
409 
410  aList.emplace_back( _( "Line Width" ), msg, BLUE );
411 
412  msg.Printf( wxT( "(%d, %d, %d, %d)" ), bBox.GetOrigin().x,
413  bBox.GetOrigin().y, bBox.GetEnd().x, bBox.GetEnd().y );
414 
415  aList.emplace_back( _( "Bounding Box" ), msg, BROWN );
416 }
Definition: colors.h:57
const EDA_RECT GetBoundingBox() const override
Function GetBoundingBox returns the orthogonal, bounding box of this object for display purposes.
Definition: lib_arc.cpp:338
const wxPoint GetEnd() const
Definition: eda_rect.h:116
const wxPoint GetOrigin() const
Definition: eda_rect.h:114
void GetMsgPanelInfo(EDA_DRAW_FRAME *aFrame, 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, EDA_DATA_TYPE aType)
Definition: base_units.cpp:124
#define _(s)
Definition: 3d_actions.cpp:33
EDA_RECT handles the component boundary box.
Definition: eda_rect.h:44
EDA_UNITS GetUserUnits() const
Return the user units currently in use.
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(), EDA_BASE_FRAME::GetUserUnits(), m_Width, MessageTextFromValue(), wxPoint::x, and wxPoint::y.

◆ GetParent()

◆ GetPenWidth()

int LIB_ARC::GetPenWidth ( ) const
overridevirtual

Implements LIB_ITEM.

Definition at line 286 of file lib_arc.cpp.

287 {
288  // Historically 0 meant "default width" and negative numbers meant "don't stroke".
289  if( m_Width < 0 && GetFillMode() != NO_FILL )
290  return 0;
291  else
292  return std::max( m_Width, 1 );
293 }
FILL_T GetFillMode() const
Definition: lib_item.h:301
int m_Width
Definition: lib_arc.h:50

References LIB_ITEM::GetFillMode(), m_Width, and NO_FILL.

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

◆ GetPosition()

const wxPoint LIB_ARC::GetPosition ( ) const
inlineoverridevirtual

◆ GetRadius()

int LIB_ARC::GetRadius ( ) const
inline

◆ GetSecondRadiusAngle()

int LIB_ARC::GetSecondRadiusAngle ( ) const
inline

Definition at line 109 of file lib_arc.h.

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

References m_t2.

Referenced by KIGFX::SCH_PAINTER::draw(), SCH_SEXPR_PLUGIN_CACHE::saveArc(), 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 419 of file lib_arc.cpp.

420 {
421  return wxString::Format( _( "Arc center (%s, %s), radius %s" ),
422  MessageTextFromValue( aUnits, m_Pos.x ),
423  MessageTextFromValue( aUnits, m_Pos.y ),
424  MessageTextFromValue( aUnits, m_Radius ) );
425 }
int m_Radius
Definition: lib_arc.h:44
wxPoint m_Pos
Definition: lib_arc.h:49
wxString MessageTextFromValue(EDA_UNITS aUnits, int aValue, bool aUseMils, EDA_DATA_TYPE aType)
Definition: base_units.cpp:124
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:33

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

224  {
225  return m_Status & type;
226  }
STATUS_FLAGS m_Status
Definition: base_struct.h:177

References EDA_ITEM::m_Status.

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

◆ GetStatus()

STATUS_FLAGS EDA_ITEM::GetStatus ( ) const
inlineinherited

Definition at line 236 of file base_struct.h.

236 { return m_Status; }
STATUS_FLAGS m_Status
Definition: base_struct.h:177

References EDA_ITEM::m_Status.

Referenced by PCB_IO::format().

◆ 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:33

References _.

◆ GetUnit()

◆ GetWidth()

int LIB_ARC::GetWidth ( ) const
inlineoverridevirtual

Implements LIB_ITEM.

Definition at line 99 of file lib_arc.h.

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

References m_Width.

Referenced by HitTest(), SCH_SEXPR_PLUGIN_CACHE::saveArc(), 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 62 of file lib_arc.cpp.

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

105 {
106  if( m_Flags & ( STRUCT_DELETED | SKIP_STRUCT ) )
107  return false;
108 
110  int radius = GetRadius();
111  int lineWidth = GetWidth();
112  EDA_RECT sel = aRect ;
113 
114  if ( aAccuracy )
115  sel.Inflate( aAccuracy );
116 
117  if( aContained )
118  return sel.Contains( GetBoundingBox() );
119 
120  EDA_RECT arcRect = GetBoundingBox().Common( sel );
121 
122  /* All following tests must pass:
123  * 1. Rectangle must intersect arc BoundingBox
124  * 2. Rectangle must cross the outside of the arc
125  */
126  return arcRect.Intersects( sel ) && arcRect.IntersectsCircleEdge( center, radius, lineWidth );
127 }
#define SKIP_STRUCT
flag indicating that the structure should be ignored
Definition: base_struct.h:128
const EDA_RECT GetBoundingBox() const override
Function GetBoundingBox returns the orthogonal, bounding box of this object for display purposes.
Definition: lib_arc.cpp:338
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
const wxPoint GetPosition() const override
Definition: lib_arc.h:90
#define STRUCT_DELETED
flag indication structures to be erased
Definition: base_struct.h:126
int GetRadius() const
Definition: lib_arc.h:103
int GetWidth() const override
Definition: lib_arc.h:99
STATUS_FLAGS m_Flags
Definition: base_struct.h:180
EDA_RECT handles the component boundary box.
Definition: eda_rect.h:44
bool Intersects(const EDA_RECT &aRect) const
Function Intersects tests for a common area between rectangles.
EDA_RECT & Inflate(wxCoord dx, wxCoord dy)
Function Inflate inflates the rectangle horizontally by dx and vertically by dy.

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

◆ IsBrightened()

bool EDA_ITEM::IsBrightened ( ) const
inlineinherited

◆ IsDragging()

bool EDA_ITEM::IsDragging ( ) const
inlineinherited

Definition at line 205 of file base_struct.h.

205 { return m_Flags & IS_DRAGGED; }
#define IS_DRAGGED
Item being dragged.
Definition: base_struct.h:119
STATUS_FLAGS m_Flags
Definition: base_struct.h:180

References IS_DRAGGED, and EDA_ITEM::m_Flags.

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

◆ 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 292 of file lib_item.h.

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

References LIB_ITEM::m_isFillable.

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

◆ IsForceVisible()

bool EDA_ITEM::IsForceVisible ( ) const
inlineinherited

Definition at line 293 of file base_struct.h.

293 { return m_forceVisible; }
bool m_forceVisible
Definition: base_struct.h:179

References EDA_ITEM::m_forceVisible.

Referenced by KIGFX::SCH_PAINTER::draw(), and SCH_FIELD::Print().

◆ IsHighlighted()

bool EDA_ITEM::IsHighlighted ( ) const
inlineinherited

Definition at line 209 of file base_struct.h.

209 { return m_Flags & HIGHLIGHTED; }
#define HIGHLIGHTED
item is drawn in normal colors, when the rest is darkened
Definition: base_struct.h:139
STATUS_FLAGS m_Flags
Definition: base_struct.h:180

References HIGHLIGHTED, and EDA_ITEM::m_Flags.

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

◆ IsModified()

bool EDA_ITEM::IsModified ( ) const
inlineinherited

Definition at line 202 of file base_struct.h.

202 { return m_Flags & IS_CHANGED; }
#define IS_CHANGED
std::function passed to nested users by ref, avoids copying std::function
Definition: base_struct.h:113
STATUS_FLAGS m_Flags
Definition: base_struct.h:180

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_SHEET_PIN, and SCH_FIELD.

Definition at line 508 of file base_struct.h.

508 { return false; }

Referenced by EDA_ITEM::Matches().

◆ IsResized()

bool EDA_ITEM::IsResized ( ) const
inlineinherited

Definition at line 208 of file base_struct.h.

208 { return m_Flags & IS_RESIZED; }
STATUS_FLAGS m_Flags
Definition: base_struct.h:180
#define IS_RESIZED
Item being resized.
Definition: base_struct.h:118

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, VIA, D_PAD, DIMENSION, DRAWSEGMENT, TEXTE_MODULE, SCH_FIELD, SCH_LINE, EDGE_MODULE, and TEXTE_PCB.

Definition at line 269 of file base_struct.h.

270  {
271  if( aScanTypes[0] == SCH_LOCATE_ANY_T )
272  return true;
273 
274  for( const KICAD_T* p = aScanTypes; *p != EOT; ++p )
275  {
276  if( m_StructType == *p )
277  return true;
278  }
279 
280  return false;
281  }
KICAD_T m_StructType
Run time identification, keep private so it can never be changed after a constructor sets it.
Definition: base_struct.h:174
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 GetRule(), SCH_LINE_WIRE_BUS_TOOL::IsDrawingBus(), SCH_LINE_WIRE_BUS_TOOL::IsDrawingLine(), SCH_LINE_WIRE_BUS_TOOL::IsDrawingWire(), TEXTE_PCB::IsType(), EDGE_MODULE::IsType(), SCH_LINE::IsType(), SCH_FIELD::IsType(), TEXTE_MODULE::IsType(), DRAWSEGMENT::IsType(), DIMENSION::IsType(), D_PAD::IsType(), VIA::IsType(), SCH_LABEL::IsType(), EE_POINT_EDITOR::Main(), PL_POINT_EDITOR::Main(), EE_SELECTION_TOOL::RequestSelection(), PCB_BASE_EDIT_FRAME::SaveCopyInUndoList(), EDA_ITEM::Visit(), and DIALOG_GLOBAL_EDIT_TEXT_AND_GRAPHICS::visitItem().

◆ IsWireImage()

bool EDA_ITEM::IsWireImage ( ) const
inlineinherited

Definition at line 206 of file base_struct.h.

206 { return m_Flags & IS_WIRE_IMAGE; }
#define IS_WIRE_IMAGE
Item to be drawn as wireframe while editing.
Definition: base_struct.h:121
STATUS_FLAGS m_Flags
Definition: base_struct.h:180

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

394  {
395  for( auto it : aList )
396  {
397  if( static_cast<EDA_ITEM*>( it )->Visit( inspector, testData, scanTypes )
399  return SEARCH_RESULT::QUIT;
400  }
401 
403  }
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 411 of file base_struct.h.

413  {
414  for( auto it : aList )
415  {
416  if( static_cast<EDA_ITEM*>( it )->Visit( inspector, testData, scanTypes )
418  return SEARCH_RESULT::QUIT;
419  }
420 
422  }
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_SHEET_PIN, SCH_FIELD, LIB_PIN, SCH_PIN, TEXTE_MODULE, SCH_MARKER, MARKER_PCB, and TEXTE_PCB.

Definition at line 464 of file base_struct.h.

465  {
466  return false;
467  }

Referenced by SCH_EDITOR_CONTROL::HasMatch(), TEXTE_PCB::Matches(), MARKER_PCB::Matches(), SCH_MARKER::Matches(), TEXTE_MODULE::Matches(), LIB_PIN::Matches(), SCH_FIELD::Matches(), SCH_SHEET_PIN::Matches(), SCH_TEXT::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 143 of file base_struct.cpp.

144 {
145  wxString text = aText;
146  wxString searchText = aSearchData.GetFindString();
147 
148  // Don't match if searching for replaceable item and the item doesn't support text replace.
149  if( (aSearchData.GetFlags() & FR_SEARCH_REPLACE) && !IsReplaceable() )
150  return false;
151 
152  if( aSearchData.GetFlags() & wxFR_WHOLEWORD )
153  return aText.IsSameAs( searchText, aSearchData.GetFlags() & wxFR_MATCHCASE );
154 
155  if( aSearchData.GetFlags() & FR_MATCH_WILDCARD )
156  {
157  if( aSearchData.GetFlags() & wxFR_MATCHCASE )
158  return text.Matches( searchText );
159 
160  return text.MakeUpper().Matches( searchText.MakeUpper() );
161  }
162 
163  if( aSearchData.GetFlags() & wxFR_MATCHCASE )
164  return aText.Find( searchText ) != wxNOT_FOUND;
165 
166  return text.MakeUpper().Find( searchText.MakeUpper() ) != wxNOT_FOUND;
167 }
virtual bool IsReplaceable() const
Function IsReplaceable.
Definition: base_struct.h:508

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

181 {
182  m_Pos.x -= aCenter.x;
183  m_Pos.x *= -1;
184  m_Pos.x += aCenter.x;
185  m_ArcStart.x -= aCenter.x;
186  m_ArcStart.x *= -1;
187  m_ArcStart.x += aCenter.x;
188  m_ArcEnd.x -= aCenter.x;
189  m_ArcEnd.x *= -1;
190  m_ArcEnd.x += aCenter.x;
191  std::swap( m_ArcStart, m_ArcEnd );
192  std::swap( m_t1, m_t2 );
193  m_t1 = 1800 - m_t1;
194  m_t2 = 1800 - m_t2;
195  if( m_t1 > 3600 || m_t2 > 3600 )
196  {
197  m_t1 -= 3600;
198  m_t2 -= 3600;
199  }
200  else if( m_t1 < -3600 || m_t2 < -3600 )
201  {
202  m_t1 += 3600;
203  m_t2 += 3600;
204  }
205 }
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 207 of file lib_arc.cpp.

208 {
209  m_Pos.y -= aCenter.y;
210  m_Pos.y *= -1;
211  m_Pos.y += aCenter.y;
212  m_ArcStart.y -= aCenter.y;
213  m_ArcStart.y *= -1;
214  m_ArcStart.y += aCenter.y;
215  m_ArcEnd.y -= aCenter.y;
216  m_ArcEnd.y *= -1;
217  m_ArcEnd.y += aCenter.y;
218  std::swap( m_ArcStart, m_ArcEnd );
219  std::swap( m_t1, m_t2 );
220  m_t1 = - m_t1;
221  m_t2 = - m_t2;
222  if( m_t1 > 3600 || m_t2 > 3600 )
223  {
224  m_t1 -= 3600;
225  m_t2 -= 3600;
226  }
227  else if( m_t1 < -3600 || m_t2 < -3600 )
228  {
229  m_t1 += 3600;
230  m_t2 += 3600;
231  }
232 }
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 171 of file lib_arc.cpp.

172 {
173  wxPoint offset = aPosition - m_Pos;
174  m_Pos = aPosition;
175  m_ArcStart += offset;
176  m_ArcEnd += offset;
177 }
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 163 of file lib_arc.cpp.

164 {
165  m_Pos += aOffset;
166  m_ArcStart += aOffset;
167  m_ArcEnd += aOffset;
168 }
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 101 of file lib_item.cpp.

102 {
103  int result = m_Convert - aOther.m_Convert;
104 
105  if( result != 0 )
106  return result < 0;
107 
108  result = m_Unit - aOther.m_Unit;
109 
110  if( result != 0 )
111  return result < 0;
112 
113  result = Type() - aOther.Type();
114 
115  if( result != 0 )
116  return result < 0;
117 
118  return ( compare( aOther ) < 0 );
119 }
int m_Unit
Unit identification for multiple parts per package.
Definition: lib_item.h:81
int m_Convert
Shape identification for alternate body styles.
Definition: lib_item.h:87
virtual int compare(const LIB_ITEM &aOther, LIB_ITEM::COMPARE_FLAGS aCompareFlags=LIB_ITEM::COMPARE_FLAGS::NORMAL) const
Provide the draw object specific comparison called by the == and < operators.
Definition: lib_item.cpp:76
KICAD_T Type() const
Function Type()
Definition: base_struct.h:197

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

198 {
199  wxFAIL_MSG( wxString::Format( wxT( "Less than operator not defined for item type %s." ),
200  GetChars( GetClass() ) ) );
201 
202  return false;
203 }
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:153
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 95 of file lib_item.cpp.

96 {
97  return compare( aOther ) == 0;
98 }
virtual int compare(const LIB_ITEM &aOther, LIB_ITEM::COMPARE_FLAGS aCompareFlags=LIB_ITEM::COMPARE_FLAGS::NORMAL) const
Provide the draw object specific comparison called by the == and < operators.
Definition: lib_item.cpp:76

References LIB_ITEM::compare().

◆ operator==() [2/2]

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

Definition at line 221 of file lib_item.h.

222  {
223  return *this == *aOther;
224  }

◆ 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 256 of file lib_arc.cpp.

258 {
259  wxASSERT( aPlotter != NULL );
260 
261  int t1 = m_t1;
262  int t2 = m_t2;
263  wxPoint pos = aTransform.TransformCoordinate( m_Pos ) + aOffset;
264 
265  aTransform.MapAngles( &t1, &t2 );
266 
267  if( aFill && m_Fill == FILLED_WITH_BG_BODYCOLOR )
268  {
269  aPlotter->SetColor( aPlotter->RenderSettings()->GetLayerColor( LAYER_DEVICE_BACKGROUND ) );
270  aPlotter->Arc( pos, -t2, -t1, m_Radius, FILLED_WITH_BG_BODYCOLOR, 0 );
271  }
272 
273  bool already_filled = m_Fill == FILLED_WITH_BG_BODYCOLOR;
274  int pen_size = GetPenWidth();
275 
276  if( !already_filled || pen_size > 0 )
277  {
278  pen_size = std::max( pen_size, aPlotter->RenderSettings()->GetDefaultPenWidth() );
279 
280  aPlotter->SetColor( aPlotter->RenderSettings()->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
const COLOR4D & GetLayerColor(int aLayer) const
Function GetLayerColor Returns the color used to draw a layer.
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
RENDER_SETTINGS * RenderSettings()
Definition: plotter.h:137
int GetPenWidth() 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:158
int GetDefaultPenWidth() const
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, KIGFX::RENDER_SETTINGS::GetDefaultPenWidth(), KIGFX::RENDER_SETTINGS::GetLayerColor(), GetPenWidth(), LAYER_DEVICE, LAYER_DEVICE_BACKGROUND, LIB_ITEM::m_Fill, m_Pos, m_Radius, m_t1, m_t2, TRANSFORM::MapAngles(), NO_FILL, NULL, PLOTTER::RenderSettings(), PLOTTER::SetColor(), and TRANSFORM::TransformCoordinate().

◆ print()

void LIB_ARC::print ( RENDER_SETTINGS aSettings,
const wxPoint aOffset,
void *  aData,
const TRANSFORM aTransform 
)
overrideprivatevirtual

Print the item to aDC.

Parameters
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 296 of file lib_arc.cpp.

298 {
299  bool forceNoFill = static_cast<bool>( aData );
300  int penWidth = GetPenWidth();
301 
302  if( forceNoFill && m_Fill != NO_FILL && penWidth == 0 )
303  return;
304 
305  wxDC* DC = aSettings->GetPrintDC();
306  wxPoint pos1, pos2, posc;
307  COLOR4D color = aSettings->GetLayerColor( LAYER_DEVICE );
308 
309  pos1 = aTransform.TransformCoordinate( m_ArcEnd ) + aOffset;
310  pos2 = aTransform.TransformCoordinate( m_ArcStart ) + aOffset;
311  posc = aTransform.TransformCoordinate( m_Pos ) + aOffset;
312  int pt1 = m_t1;
313  int pt2 = m_t2;
314  bool swap = aTransform.MapAngles( &pt1, &pt2 );
315 
316  if( swap )
317  {
318  std::swap( pos1.x, pos2.x );
319  std::swap( pos1.y, pos2.y );
320  }
321 
322  if( forceNoFill || m_Fill == NO_FILL )
323  {
324  penWidth = std::max( penWidth, aSettings->GetDefaultPenWidth() );
325 
326  GRArc1( nullptr, DC, pos1.x, pos1.y, pos2.x, pos2.y, posc.x, posc.y, penWidth, color );
327  }
328  else
329  {
332 
333  GRFilledArc( nullptr, DC, posc.x, posc.y, pt1, pt2, m_Radius, penWidth, color, color );
334  }
335 }
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
const COLOR4D & GetLayerColor(int aLayer) const
Function GetLayerColor Returns the color used to draw a layer.
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 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
int GetPenWidth() const override
Definition: lib_arc.cpp:286
FILL_T m_Fill
The body fill type.
Definition: lib_item.h:93
int GetDefaultPenWidth() const
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:40

References color, FILLED_WITH_BG_BODYCOLOR, KIGFX::RENDER_SETTINGS::GetDefaultPenWidth(), KIGFX::RENDER_SETTINGS::GetLayerColor(), GetPenWidth(), KIGFX::RENDER_SETTINGS::GetPrintDC(), 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 ( RENDER_SETTINGS aSettings,
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 139 of file lib_item.cpp.

141 {
142  print( aSettings, aOffset, aData, aTransform );
143 }
virtual void print(RENDER_SETTINGS *aSettings, 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 170 of file base_struct.cpp.

171 {
172  wxString searchString = (aSearchData.GetFlags() & wxFR_MATCHCASE) ? aText : aText.Upper();
173 
174  int result = searchString.Find( (aSearchData.GetFlags() & wxFR_MATCHCASE) ?
175  aSearchData.GetFindString() :
176  aSearchData.GetFindString().Upper() );
177 
178  if( result == wxNOT_FOUND )
179  return false;
180 
181  wxString prefix = aText.Left( result );
182  wxString suffix;
183 
184  if( aSearchData.GetFindString().length() + result < aText.length() )
185  suffix = aText.Right( aText.length() - ( aSearchData.GetFindString().length() + result ) );
186 
187  wxLogTrace( traceFindReplace, wxT( "Replacing '%s', prefix '%s', replace '%s', suffix '%s'." ),
188  GetChars( aText ), GetChars( prefix ), GetChars( aSearchData.GetReplaceString() ),
189  GetChars( suffix ) );
190 
191  aText = prefix + aSearchData.GetReplaceString() + suffix;
192 
193  return true;
194 }
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:153

References GetChars(), and traceFindReplace.

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

Definition at line 496 of file base_struct.h.

496 { 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 234 of file lib_arc.cpp.

235 {
236  int rot_angle = aRotateCCW ? -900 : 900;
237  RotatePoint( &m_Pos, aCenter, rot_angle );
238  RotatePoint( &m_ArcStart, aCenter, rot_angle );
239  RotatePoint( &m_ArcEnd, aCenter, rot_angle );
240  m_t1 -= rot_angle;
241  m_t2 -= rot_angle;
242  if( m_t1 > 3600 || m_t2 > 3600 )
243  {
244  m_t1 -= 3600;
245  m_t2 -= 3600;
246  }
247  else if( m_t1 < -3600 || m_t2 < -3600 )
248  {
249  m_t1 += 3600;
250  m_t2 += 3600;
251  }
252 }
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

◆ 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 115 of file lib_arc.h.

115 { 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 105 of file lib_arc.h.

105 { 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 239 of file base_struct.h.

239 { m_Flags |= aMask; }
STATUS_FLAGS m_Flags
Definition: base_struct.h:180

References EDA_ITEM::m_Flags.

Referenced by SCH_EAGLE_PLUGIN::addBusEntries(), PCB_BASE_FRAME::AddModuleToBoard(), PCBNEW_CONTROL::AppendBoard(), SCH_EDIT_TOOL::ChangeTextType(), SCH_EDIT_FRAME::ConvertPart(), SCH_DRAWING_TOOLS::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_DRAWING_TOOLS::DrawSheet(), 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(), LIB_MOVE_TOOL::moveItem(), SCH_MOVE_TOOL::moveItem(), KIGFX::ORIGIN_VIEWITEM::ORIGIN_VIEWITEM(), LIB_EDIT_TOOL::Paste(), SCH_EDITOR_CONTROL::Paste(), SCH_DRAWING_TOOLS::PlaceComponent(), SCH_DRAWING_TOOLS::PlaceImage(), PL_DRAWING_TOOLS::PlaceItem(), PCB_EDITOR_CONTROL::PlaceModule(), DRAWING_TOOL::PlaceText(), SCH_EDIT_FRAME::PutDataInPreviousState(), SCH_EDIT_TOOL::RepeatDrawItem(), LIB_PIN_TOOL::RepeatPin(), LIB_EDIT_FRAME::SaveCopyInUndoList(), EE_SELECTION_TOOL::selectMultiple(), EE_SELECTION_TOOL::SelectPoint(), SCH_EDIT_FRAME::SelectUnit(), EDA_ITEM::SetBrightened(), LIB_PIN::SetConversion(), EDA_ITEM::SetHighlighted(), EDA_ITEM::SetModified(), EDA_ITEM::SetSelected(), EDA_ITEM::SetWireImage(), SCH_DRAWING_TOOLS::SingleClickPlace(), SCH_LINE_WIRE_BUS_TOOL::startSegments(), WS_DATA_ITEM::SyncDrawItems(), WS_DATA_ITEM_TEXT::SyncDrawItems(), DIALOG_TARGET_PROPERTIES::TransferDataFromWindow(), DIALOG_EDIT_COMPONENT_IN_SCHEMATIC::TransferDataFromWindow(), DIALOG_TEXT_PROPERTIES::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 291 of file base_struct.h.

291 { m_forceVisible = aEnable; }
bool m_forceVisible
Definition: base_struct.h:179

References EDA_ITEM::m_forceVisible.

◆ SetHighlighted()

void EDA_ITEM::SetHighlighted ( )
inlineinherited

Definition at line 214 of file base_struct.h.

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

References HIGHLIGHTED, and EDA_ITEM::SetFlags().

◆ SetModified()

◆ SetParent()

virtual void EDA_ITEM::SetParent ( EDA_ITEM aParent)
inlinevirtualinherited

Definition at line 200 of file base_struct.h.

200 { m_Parent = aParent; }
EDA_ITEM * m_Parent
Linked list: Link (parent struct)
Definition: base_struct.h:178

References EDA_ITEM::m_Parent.

Referenced by MODULE::Add(), BOARD::Add(), FOOTPRINT_VIEWER_FRAME::AddFootprintToPCB(), BOARD_NETLIST_UPDATER::addNewComponent(), SCH_SHEET::AddPin(), LIB_CONTROL::AddSymbolToSchematic(), SCH_SCREEN::Append(), LIB_FIELD::Copy(), SCH_DRAWING_TOOLS::createNewText(), DIALOG_LIB_EDIT_PIN::DIALOG_LIB_EDIT_PIN(), SCH_LINE_WIRE_BUS_TOOL::doUnfoldBus(), SCH_EDIT_TOOL::Duplicate(), PCB_EDIT_FRAME::Exchange_Module(), PCB_IO::FootprintSave(), DISPLAY_FOOTPRINTS_FRAME::Get_Module(), LIB_PART::LIB_PART(), FOOTPRINT_EDIT_FRAME::Load_Module_From_BOARD(), SCH_SEXPR_PLUGIN::loadHierarchy(), SCH_LEGACY_PLUGIN::loadHierarchy(), LIB_EDIT_FRAME::LoadOneSymbol(), MODULE::MODULE(), DIALOG_LIB_EDIT_PIN::OnPaintShowPanel(), MODULE::operator=(), LIB_PART::operator=(), PCB_PARSER::parseMODULE_unchecked(), SCH_SEXPR_PARSER::ParseSchematic(), SCH_SEXPR_PARSER::ParseSymbol(), LIB_EDIT_TOOL::Paste(), PCBNEW_CONTROL::Paste(), SCH_EDITOR_CONTROL::Paste(), pasteModuleItemsToModEdit(), SCH_DRAWING_TOOLS::PlaceComponent(), PCB_EDITOR_CONTROL::PlaceModule(), BOARD_COMMIT::Push(), SCH_SEXPR_PLUGIN_CACHE::removeSymbol(), SCH_LEGACY_PLUGIN_CACHE::removeSymbol(), PCB_BASE_EDIT_FRAME::SaveCopyInUndoList(), SaveCopyOfZones(), FOOTPRINT_EDIT_FRAME::SaveFootprintToBoard(), SCH_SHEET_PIN::SCH_SHEET_PIN(), LIB_PART::SetFields(), LIB_PART::SetParent(), SCH_DRAWING_TOOLS::SingleClickPlace(), SCH_SHEET::SwapData(), SCH_COMPONENT::SwapData(), SwapItemData(), and DIALOG_EDIT_COMPONENT_IN_SCHEMATIC::UpdateFieldsFromLibrary().

◆ SetPosition()

◆ SetRadius()

void LIB_ARC::SetRadius ( int  aRadius)
inline

Definition at line 102 of file lib_arc.h.

102 { 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 108 of file lib_arc.h.

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

References m_t2.

Referenced by SCH_LEGACY_PLUGIN_CACHE::loadArc().

◆ SetSelected()

◆ SetStart()

void LIB_ARC::SetStart ( const wxPoint aPoint)
inline

Definition at line 112 of file lib_arc.h.

112 { 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 228 of file base_struct.h.

229  {
230  if( state )
231  m_Status |= type; // state = ON or OFF
232  else
233  m_Status &= ~type;
234  }
STATUS_FLAGS m_Status
Definition: base_struct.h:177

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

237 { m_Status = aStatus; }
STATUS_FLAGS m_Status
Definition: base_struct.h:177

References EDA_ITEM::m_Status.

Referenced by BOARD_NETLIST_UPDATER::UpdateNetlist().

◆ SetUnit()

◆ SetWidth()

void LIB_ARC::SetWidth ( int  aWidth)
inlineoverridevirtual

Implements LIB_ITEM.

Definition at line 100 of file lib_arc.h.

100 { 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 212 of file base_struct.h.

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

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

527 { 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 197 of file base_struct.h.

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

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(), SCH_SCREEN::Append(), 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_EDIT_TOOL::ChangeTextType(), SCH_MARKER::ClassOf(), SCH_JUNCTION::ClassOf(), TEXTE_PCB::ClassOf(), MARKER_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(), ZONE_CONTAINER::ClassOf(), SCH_BITMAP::ClassOf(), DIMENSION::ClassOf(), TRACK::ClassOf(), NETINFO_ITEM::ClassOf(), SCH_SHEET_PIN::ClassOf(), MODULE::ClassOf(), SCH_BUS_WIRE_ENTRY::ClassOf(), D_PAD::ClassOf(), SCH_COMPONENT::ClassOf(), SCH_SCREEN::ClassOf(), SCH_BUS_BUS_ENTRY::ClassOf(), SCH_TEXT::ClassOf(), BOARD::ClassOf(), SCH_SHEET::ClassOf(), ARC::ClassOf(), VIA::ClassOf(), SCH_LABEL::ClassOf(), SCH_GLOBALLABEL::ClassOf(), SCH_HIERLABEL::ClassOf(), TRACKS_CLEANER::cleanupSegments(), LIB_BEZIER::compare(), LIB_CIRCLE::compare(), LIB_RECTANGLE::compare(), LIB_TEXT::compare(), LIB_POLYLINE::compare(), compare(), LIB_FIELD::compare(), LIB_ITEM::compare(), LIB_PIN::compare(), GRID_HELPER::computeAnchors(), SCH_BUS_WIRE_ENTRY::ConnectionPropagatesTo(), EE_RTREE::contains(), DIALOG_TEXT_PROPERTIES::convertKIIDsToReferences(), DIALOG_LABEL_EDITOR::convertKIIDsToReferences(), MODULE::CoverageRatio(), BOARD_ADAPTER::createLayers(), PCB_BASE_FRAME::CreateNewModule(), SCH_DRAWING_TOOLS::createNewText(), BOARD_ADAPTER::createNewTrack(), 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(), CN_ITEM::Dump(), EDIT_TOOL::Duplicate(), SCH_ITEM::Duplicate(), MODULE::DuplicateItem(), SCH_EDIT_TOOL::EditField(), SCH_EDIT_TOOL::editFieldText(), LIB_EDIT_TOOL::editTextProperties(), EditToolSelectionFilter(), CONNECTION_GRAPH::ercCheckBusToBusEntryConflicts(), CONNECTION_GRAPH::ercCheckLabels(), NETLIST_EXPORTER::findNextComponent(), PCB_BASE_FRAME::FocusOnItem(), EDIT_TOOL::FootprintFilter(), SCH_SEXPR_PLUGIN::Format(), SCH_LEGACY_PLUGIN::Format(), PCB_IO::Format(), PCB_IO::format(), FormatProbeItem(), POINT_EDITOR::get45DegConstrainer(), CN_ITEM::GetAnchor(), BOARD_ITEM::GetBoard(), SCH_FIELD::GetBoundingBox(), TRACK::GetBoundingBox(), SCH_FIELD::GetCanonicalName(), KIGFX::GERBVIEW_RENDER_SETTINGS::GetColor(), KIGFX::PCB_RENDER_SETTINGS::GetColor(), NETLIST_OBJECT::GetComponentParent(), SCH_MOVE_TOOL::getConnectedDragItems(), SCH_TEXT::GetConnectionPoints(), SCH_TEXT::GetContextualTextVars(), CONNECTION_GRAPH::getDefaultConnection(), CONNECTION_SUBGRAPH::GetDriverPriority(), SCH_TEXT::GetEndPoints(), PL_EDITOR_FRAME::GetLayoutFromRedoList(), PL_EDITOR_FRAME::GetLayoutFromUndoList(), SCH_FIELD::GetMenuImage(), TEXTE_PCB::GetMsgPanelInfo(), SCH_TEXT::GetMsgPanelInfo(), SCH_FIELD::GetName(), CONNECTION_SUBGRAPH::GetNameForDriver(), CONNECTIVITY_DATA::GetNetItems(), LIB_PART::GetNextDrawItem(), DRAWSEGMENT::GetParentModule(), LIB_PART::GetPin(), SCH_COMPONENT::GetPinPhysicalPosition(), SCH_FIELD::GetPosition(), getRect(), KIGFX::SCH_PAINTER::getRenderColor(), TEXTE_PCB::GetShownText(), SCH_FIELD::GetShownText(), SCH_TEXT::GetShownText(), SELECTION_TOOL::GuessSelectionCandidates(), EE_SELECTION_TOOL::GuessSelectionCandidates(), hash_eda(), EE_SELECTION_TOOL::highlight(), SELECTION_TOOL::highlight(), KIGFX::SCH_VIEW::HighlightItem(), highlightNet(), 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_FIELD::IsReplaceable(), SCH_SCREEN::IsTerminalPoint(), BOARD_ITEM::IsTrack(), itemIsIncludedByFilter(), CLIPBOARD_IO::Load(), PNS_PCBNEW_RULE_RESOLVER::localPadClearance(), EE_POINT_EDITOR::Main(), LIB_MOVE_TOOL::Main(), SCH_MOVE_TOOL::Main(), EE_SELECTION_TOOL::Main(), EDIT_POINTS_FACTORY::Make(), SCH_SCREEN::MarkConnections(), CN_CONNECTIVITY_ALGO::markItemNetAsDirty(), CONNECTIVITY_DATA::MarkItemNetAsDirty(), SCH_FIELD::Matches(), SCH_LINE::MergeOverlap(), SCH_EDIT_TOOL::Mirror(), SCH_MOVE_TOOL::moveItem(), SCH_EDITOR_CONTROL::nextMatch(), FOOTPRINT_EDIT_FRAME::OnEditItemRequest(), PCB_EDIT_FRAME::OnEditItemRequest(), POINT_EDITOR::OnSelectionChange(), SCH_JUNCTION::operator<(), SCH_BUS_ENTRY_BASE::operator<(), SCH_FIELD::operator<(), SCH_LINE::operator<(), LIB_ITEM::operator<(), SCH_TEXT::operator<(), SCH_ITEM::operator<(), SCH_SHEET::operator<(), SCH_COMPONENT::operator<(), SCH_BITMAP::operator=(), SCH_SHEET::operator=(), SCH_COMPONENT::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::PlotFootprintGraphicItem(), SCH_FIELD::Print(), 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_CONNECTION::recacheName(), SCH_BASE_FRAME::RefreshItem(), SCH_BASE_FRAME::RefreshSelection(), EE_RTREE::remove(), MODULE::Remove(), CN_CONNECTIVITY_ALGO::Remove(), BOARD::Remove(), SCH_SCREEN::Remove(), POINT_EDITOR::removeCorner(), POINT_EDITOR::removeCornerCondition(), LIB_PART::RemoveDrawItem(), SCH_SHEET::RemovePin(), SCH_EDIT_TOOL::RepeatDrawItem(), SCH_FIELD::Replace(), WS_PROXY_UNDO_ITEM::Restore(), PL_EDITOR_FRAME::RollbackFromUndo(), SCH_EDIT_TOOL::Rotate(), SCH_TEXT::Rotate(), DRC_TEXTVAR_TESTER::RunDRC(), SCH_SEXPR_PLUGIN_CACHE::saveArc(), SCH_LEGACY_PLUGIN_CACHE::saveArc(), SCH_SEXPR_PLUGIN_CACHE::saveBezier(), SCH_LEGACY_PLUGIN_CACHE::saveBezier(), SCH_SEXPR_PLUGIN_CACHE::saveCircle(), SCH_LEGACY_PLUGIN_CACHE::saveCircle(), PCB_BASE_EDIT_FRAME::SaveCopyInUndoList(), EE_TOOL_BASE< SCH_BASE_FRAME >::saveCopyInUndoList(), SCH_SEXPR_PLUGIN::saveField(), SCH_SEXPR_PLUGIN_CACHE::saveField(), SCH_LEGACY_PLUGIN_CACHE::saveField(), SCH_SEXPR_PLUGIN_CACHE::savePin(), SCH_LEGACY_PLUGIN_CACHE::savePin(), SCH_SEXPR_PLUGIN_CACHE::savePolyLine(), SCH_LEGACY_PLUGIN_CACHE::savePolyLine(), SCH_SEXPR_PLUGIN_CACHE::saveRectangle(), SCH_LEGACY_PLUGIN_CACHE::saveRectangle(), SCH_SEXPR_PLUGIN_CACHE::saveSymbolDrawItem(), SCH_SEXPR_PLUGIN::saveText(), SCH_SEXPR_PLUGIN_CACHE::saveText(), SCH_LEGACY_PLUGIN_CACHE::saveText(), SCH_SCREEN::Schematic(), SCH_ITEM::Schematic(), SELECTION_TOOL::select(), SELECTION_TOOL::Selectable(), EE_SELECTION_TOOL::Selectable(), SELECTION_TOOL::selectConnectedTracks(), SCH_FIELD::SetId(), ITEM_PICKER::SetItem(), SCH_FIELD::SetPosition(), DIALOG_LABEL_EDITOR::SetTitle(), PCB_EDIT_FRAME::SetTrackSegmentWidth(), BOARD_COMMIT::Stage(), SCH_JUNCTION::SwapData(), SCH_NO_CONNECT::SwapData(), SCH_BITMAP::SwapData(), PCB_TARGET::SwapData(), SCH_SHEET_PIN::SwapData(), SCH_FIELD::SwapData(), TEXTE_PCB::SwapData(), TRACK::SwapData(), DIMENSION::SwapData(), ARC::SwapData(), SCH_SHEET::SwapData(), VIA::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(), DIALOG_SCH_EDIT_ONE_FIELD::UpdateField(), EE_POINT_EDITOR::updateItem(), PL_POINT_EDITOR::updateItem(), POINT_EDITOR::updateItem(), CONNECTION_GRAPH::updateItemConnectivity(), SCH_EDITOR_CONTROL::UpdateNetHighlighting(), EE_POINT_EDITOR::updatePoints(), PL_POINT_EDITOR::updatePoints(), POINT_EDITOR::updatePoints(), EE_TOOL_BASE< SCH_BASE_FRAME >::updateView(), PCB_BRIGHT_BOX::ViewDraw(), SCH_BUS_ENTRY_BASE::ViewGetLayers(), TRACK::Visit(), GERBER_DRAW_ITEM::Visit(), SCH_SHEET::Visit(), 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, ROUTER_PREVIEW_ITEM, MARKER_PCB, KIGFX::WS_PROXY_VIEW_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 218 of file base_struct.cpp.

219 {
220  // Basic fallback
221  return BOX2I( VECTOR2I( GetBoundingBox().GetOrigin() ),
222  VECTOR2I( GetBoundingBox().GetSize() ) );
223 }
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.
Definition: base_struct.cpp:95

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, ROUTER_PREVIEW_ITEM, KIGFX::VIEW_GROUP, KIGFX::WS_PROXY_VIEW_ITEM, 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 146 of file lib_item.cpp.

147 {
148  // Basic fallback
149  aCount = 3;
150  aLayers[0] = LAYER_DEVICE;
151  aLayers[1] = LAYER_DEVICE_BACKGROUND;
152  aLayers[2] = LAYER_SELECTION_SHADOWS;
153 }

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

119 {
120 #if 0 && defined(DEBUG)
121  std::cout << GetClass().mb_str() << ' ';
122 #endif
123 
124  if( IsType( scanTypes ) )
125  {
126  if( SEARCH_RESULT::QUIT == inspector( this, testData ) )
127  return SEARCH_RESULT::QUIT;
128  }
129 
131 }
virtual bool IsType(const KICAD_T aScanTypes[]) const
Function IsType Checks whether the item is one of the listed types.
Definition: base_struct.h:269
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::compare(), LIB_ITEM::GetConvert(), LIB_ITEM::GetMsgPanelInfo(), LIB_ITEM::LIB_ITEM(), SCH_LEGACY_PLUGIN_CACHE::loadPin(), 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

◆ m_isFillable

◆ m_Parent

◆ m_Pos

◆ m_Radius

int LIB_ARC::m_Radius
private

◆ m_Status

STATUS_FLAGS EDA_ITEM::m_Status
protectedinherited

◆ m_t1

◆ m_t2

◆ m_Unit

int LIB_ITEM::m_Unit
protectedinherited

◆ m_Uuid

const KIID EDA_ITEM::m_Uuid
inherited

Definition at line 166 of file base_struct.h.

Referenced by FIELDS_EDITOR_GRID_DATA_MODEL::AddColumn(), SCH_COMPONENT::AddHierarchicalReference(), SCH_EDIT_FRAME::AnnotateComponents(), FIELDS_EDITOR_GRID_DATA_MODEL::ApplyData(), SCH_SHEET_PATH::Cmp(), DIALOG_LABEL_EDITOR::convertReferencesToKIIDs(), BOARD_ITEM::Duplicate(), SCH_ITEM::Duplicate(), PCB_EDIT_FRAME::Exchange_Module(), PCB_BASE_FRAME::FocusOnItem(), SCH_EDIT_FRAME::FocusOnItem(), PCB_IO::format(), FormatProbeItem(), SCH_PIN::GetDefaultNetName(), BOARD::GetItem(), SCH_SHEET::GetMsgPanelInfo(), SCH_REFERENCE::GetPath(), SCH_COMPONENT::GetRef(), SCH_MARKER::GetUUID(), MARKER_PCB::GetUUID(), FIELDS_EDITOR_GRID_DATA_MODEL::groupMatch(), FOOTPRINT_EDIT_FRAME::Load_Module_From_BOARD(), SCH_LEGACY_PLUGIN::loadComponent(), LEGACY_PLUGIN::loadMODULE(), LEGACY_PLUGIN::loadPCB_TARGET(), LEGACY_PLUGIN::loadPCB_TEXT(), LEGACY_PLUGIN::loadTrackList(), NETLIST_EXPORTER_GENERIC::makeComponents(), SCH_EDIT_FRAME::mapExistingAnnotation(), SCH_ITEM::operator<(), SCH_COMPONENT::operator<(), PCB_PARSER::parseDIMENSION(), SCH_EDITOR_CONTROL::Paste(), SCH_SHEET_PATH::PathAsString(), SCH_SCREENS::ReplaceDuplicateTimeStamps(), SCH_COMPONENT::ReplaceInstanceSheetPath(), SCH_LEGACY_PLUGIN::saveComponent(), FOOTPRINT_EDIT_FRAME::SaveFootprintToBoard(), SCH_EDIT_FRAME::SaveProject(), SCH_SEXPR_PLUGIN::saveSheet(), SCH_LEGACY_PLUGIN::saveSheet(), SCH_SEXPR_PLUGIN::saveSymbol(), SCH_COMPONENT::SCH_COMPONENT(), SCH_REFERENCE::SCH_REFERENCE(), SCH_SHEET::SCH_SHEET(), RC_ITEM::SetItems(), SwapItemData(), DIALOG_SCH_SHEET_PROPS::TransferDataToWindow(), DIALOG_EDIT_COMPONENT_IN_SCHEMATIC::TransferDataToWindow(), and NETLIST_EXPORTER_ORCADPCB2::WriteNetlist().

◆ m_Width

int LIB_ARC::m_Width
private

Definition at line 50 of file lib_arc.h.

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


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