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 Member Functions

 LIB_ARC (LIB_PART *aParent)
 
 ~LIB_ARC ()
 
wxString GetClass () const override
 Function GetClass returns the class name. More...
 
bool Save (OUTPUTFORMATTER &aFormatter) override
 Function Save writes draw item object to aFormatter in component library "*.lib" format. More...
 
bool Load (LINE_READER &aLineReader, wxString &aErrorMsg) override
 
bool HitTest (const wxPoint &aPosition) const override
 Function HitTest tests if aPosition is contained within or on the bounding area of an item. More...
 
bool HitTest (const wxPoint &aPosition, int aThreshold, const TRANSFORM &aTransform) const override
 
const EDA_RECT GetBoundingBox () const override
 
void GetMsgPanelInfo (std::vector< MSG_PANEL_ITEM > &aList) override
 Function GetMsgPanelInfo displays basic info (type, part and convert) about the current item in message panel. More...
 
int GetPenSize () const override
 Function GetPenSize. More...
 
void BeginEdit (STATUS_FLAGS aEditMode, const wxPoint aStartPoint=wxPoint(0, 0)) override
 Begin an editing a component library draw item in aEditMode at aPosition. More...
 
bool ContinueEdit (const wxPoint aNextPoint) override
 Continue an edit in progress at aPosition. More...
 
void EndEdit (const wxPoint &aPosition, bool aAbort=false) override
 End an object editing action. More...
 
void SetOffset (const wxPoint &aOffset) override
 Function Offset sets the drawing object by aOffset from the current position. More...
 
bool Inside (EDA_RECT &aRect) const override
 Function Inside tests if any part of the draw object is inside rectangle bounds of aRect. More...
 
void Move (const wxPoint &aPosition) override
 Function Move moves a draw object to aPosition. More...
 
wxPoint GetPosition () const override
 Function GetPosition returns the current draw object position. More...
 
void MirrorHorizontal (const wxPoint &aCenter) override
 Function MirrorHorizontal mirrors the draw object along the horizontal (X) axis about aCenter point. More...
 
void MirrorVertical (const wxPoint &aCenter) override
 Function MirrorVertical mirrors the draw object along the MirrorVertical (Y) axis about aCenter point. More...
 
void Rotate (const wxPoint &aCenter, bool aRotateCCW=true) override
 Function Rotate rotates 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
 Function GetWidth return the width of the draw item. More...
 
void SetWidth (int aWidth) override
 Function SetWidth sets the width of the draw item to aWidth. More...
 
void SetRadius (int aRadius)
 
int GetRadius () const
 
void SetFirstRadiusAngle (int aAngle)
 
int GetFirstRadiusAngle () const
 
void SetSecondRadiusAngle (int aAngle)
 
int GetSecondRadiusAngle () const
 
void SetStart (const wxPoint &aPoint)
 
void SetEnd (const wxPoint &aPoint)
 
void CalcRadiusAngles ()
 Calculate the radius and angle of an arc using the start, end, and center points. More...
 
wxString GetSelectMenuText () 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...
 
wxString GetTypeName ()
 
virtual void Draw (EDA_DRAW_PANEL *aPanel, wxDC *aDC, const wxPoint &aOffset, COLOR4D aColor, GR_DRAWMODE aDrawMode, void *aData, const TRANSFORM &aTransform)
 Draw an item. More...
 
LIB_PARTGetParent () const
 
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)
 
virtual void Rotate ()
 Rotate the draw item. More...
 
bool IsFillable () const
 Check if draw object can be filled. More...
 
bool InEditMode () const
 Return the draw item editing mode status. More...
 
void SetEraseLastDrawItem (bool aErase=true)
 
virtual COLOR4D GetDefaultColor ()
 
void SetUnit (int aUnit)
 
int GetUnit () const
 
void SetConvert (int aConvert)
 
int GetConvert () const
 
void SetFillMode (FILL_T aFillMode)
 
FILL_T GetFillMode () const
 
KICAD_T Type () const
 Function Type() More...
 
void SetTimeStamp (time_t aNewTimeStamp)
 
time_t GetTimeStamp () const
 
EDA_ITEMNext () const
 
EDA_ITEMBack () const
 
DHEADGetList () const
 
void SetNext (EDA_ITEM *aNext)
 
void SetBack (EDA_ITEM *aBack)
 
void SetParent (EDA_ITEM *aParent)
 
void SetList (DHEAD *aList)
 
bool IsNew () const
 
bool IsModified () const
 
bool IsMoving () const
 
bool IsDragging () const
 
bool IsWireImage () const
 
bool IsSelected () const
 
bool IsResized () const
 
bool IsHighlighted () const
 
bool IsBrightened () const
 
void SetWireImage ()
 
void SetSelected ()
 
void SetHighlighted ()
 
void SetBrightened ()
 
void ClearSelected ()
 
void ClearHighlighted ()
 
void ClearBrightened ()
 
void SetModified ()
 
int GetState (int type) const
 
void SetState (int type, int state)
 
STATUS_FLAGS GetStatus () const
 
void SetStatus (STATUS_FLAGS aStatus)
 
void SetFlags (STATUS_FLAGS aMask)
 
void ClearFlags (STATUS_FLAGS aMask=EDA_ITEM_ALL_FLAGS)
 
STATUS_FLAGS GetFlags () const
 
void SetForceVisible (bool aEnable)
 Function SetForceVisible is used to set and cleag force visible flag used to force the item to be drawn even if it's draw attribute is set to not visible. More...
 
virtual SEARCH_RESULT Visit (INSPECTOR inspector, void *testData, const KICAD_T scanTypes[])
 Function Visit may be re-implemented for each derived class in order to handle all the types given by its member data. More...
 
virtual bool Matches (wxFindReplaceData &aSearchData, void *aAuxData, wxPoint *aFindLocation)
 Function Matches compares the item against the search criteria in aSearchData. More...
 
bool Replace (wxFindReplaceData &aSearchData, wxString &aText)
 Helper function used in search and replace dialog Function Replace performs a text replace on aText using the find and replace criteria in aSearchData on items that support text find and replace. More...
 
virtual bool Replace (wxFindReplaceData &aSearchData, void *aAuxData=NULL)
 Function Replace performs a text replace using the find and replace criteria in aSearchData on items that support text find and replace. More...
 
virtual bool IsReplaceable () const
 Function IsReplaceable. More...
 
virtual const BOX2I ViewBBox () const override
 Function ViewBBox() returns the bounding box of the item covering all its layers. More...
 
virtual void ViewGetLayers (int aLayers[], int &aCount) const override
 Function ViewGetLayers() Returns the all the layers within the VIEW the object is painted on. More...
 
virtual void 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 of the item. More...
 
VIEW_ITEM_DATA * viewPrivData () const
 

Static Public Member Functions

static SEARCH_RESULT IterateForward (EDA_ITEM *listStart, INSPECTOR inspector, void *testData, const KICAD_T scanTypes[])
 Function IterateForward walks through the object tree calling the inspector() on each object type requested in scanTypes. More...
 
static bool Sort (const EDA_ITEM *aLeft, const EDA_ITEM *aRight)
 Function Sort is a helper function to be used by the C++ STL sort algorithm for sorting a STL container of EDA_ITEM pointers. More...
 

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...
 
wxString m_typeName
 Name of object displayed in the message panel. More...
 
wxPoint m_initialPos
 Temporary position when moving an existing item. More...
 
wxPoint m_initialCursorPos
 Initial cursor position at the beginning of a move. More...
 
bool m_isFillable
 Flag to indicate if draw item is fillable. More...
 
EDA_ITEMPnext
 next in linked list More...
 
EDA_ITEMPback
 previous in linked list More...
 
DHEADm_List
 which DLIST I am on. More...
 
EDA_ITEMm_Parent
 Linked list: Link (parent struct) More...
 
time_t m_TimeStamp
 Time stamp used for logical links. More...
 
bool m_forceVisible
 Set to true to override the visibility setting of the item. More...
 
STATUS_FLAGS m_Flags
 Flag bits for editing and other uses. More...
 

Private Types

enum  SELECT_T { ARC_STATUS_START, ARC_STATUS_END, ARC_STATUS_OUTLINE }
 

Private Member Functions

void drawGraphic (EDA_DRAW_PANEL *aPanel, wxDC *aDC, const wxPoint &aOffset, COLOR4D aColor, GR_DRAWMODE aDrawMode, void *aData, const TRANSFORM &aTransform) override
 Draws the arc. More...
 
void drawEditGraphics (EDA_RECT *aClipBox, wxDC *aDC, COLOR4D aColor) override
 Draw the graphics when the arc is being edited. More...
 
void calcEdit (const wxPoint &aPosition) override
 Calculates the center, radius, and angles at aPosition when the arc is being edited. More...
 
int compare (const LIB_ITEM &aOther) const override
 Function compare provides 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
 
double m_editCenterDistance
 
SELECT_T m_editSelectPoint
 
int m_editState
 
int m_editDirection
 
int m_lastEditState
 

Detailed Description

Definition at line 38 of file lib_arc.h.

Member Enumeration Documentation

enum LIB_ARC::SELECT_T
private
Enumerator
ARC_STATUS_START 
ARC_STATUS_END 
ARC_STATUS_OUTLINE 

Definition at line 40 of file lib_arc.h.

Constructor & Destructor Documentation

LIB_ARC::LIB_ARC ( LIB_PART aParent)

Definition at line 88 of file lib_arc.cpp.

References ARC_STATUS_START, m_editCenterDistance, m_editDirection, m_editSelectPoint, m_editState, LIB_ITEM::m_Fill, LIB_ITEM::m_isFillable, m_lastEditState, m_Radius, m_t1, m_t2, LIB_ITEM::m_typeName, m_Width, and NO_FILL.

Referenced by Clone().

88  : LIB_ITEM( LIB_ARC_T, aParent )
89 {
90  m_Radius = 0;
91  m_t1 = 0;
92  m_t2 = 0;
93  m_Width = 0;
94  m_Fill = NO_FILL;
95  m_isFillable = true;
96  m_typeName = _( "Arc" );
97  m_editState = 0;
98  m_lastEditState = 0;
101  m_editDirection = 0;
102 }
int m_Radius
Definition: lib_arc.h:47
int m_t1
Definition: lib_arc.h:48
wxString m_typeName
Name of object displayed in the message panel.
double m_editCenterDistance
Definition: lib_arc.h:54
int m_t2
Definition: lib_arc.h:49
int m_lastEditState
Definition: lib_arc.h:58
bool m_isFillable
Flag to indicate if draw item is fillable.
int m_editState
Definition: lib_arc.h:56
FILL_T m_Fill
The body fill type.
int m_editDirection
Definition: lib_arc.h:57
SELECT_T m_editSelectPoint
Definition: lib_arc.h:55
LIB_ITEM(KICAD_T aType, LIB_PART *aComponent=NULL, int aUnit=0, int aConvert=0, FILL_T aFillType=NO_FILL)
int m_Width
Definition: lib_arc.h:53
LIB_ARC::~LIB_ARC ( )
inline

Definition at line 87 of file lib_arc.h.

87 { }

Member Function Documentation

EDA_ITEM* EDA_ITEM::Back ( ) const
inlineinherited

Definition at line 221 of file base_struct.h.

References EDA_ITEM::Pback.

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

221 { return Pback; }
EDA_ITEM * Pback
previous in linked list
Definition: base_struct.h:179
void LIB_ARC::BeginEdit ( STATUS_FLAGS  aEditMode,
const wxPoint  aPosition = wxPoint( 0, 0 ) 
)
overridevirtual

Begin an editing a component library draw item in aEditMode at aPosition.

This is used to start an editing action such as resize or move a draw object. 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. It allows the draw item to maintain it's own internal state while it is being edited. Call AbortEdit() to quit the editing mode.

Parameters
aEditModeThe editing mode being performed. See base_struct.h for a list of mode flags.
aPositionThe position in drawing coordinates where the editing mode was started. This may or may not be required depending on the item being edited and the edit mode.

Reimplemented from LIB_ITEM.

Definition at line 590 of file lib_arc.cpp.

References ARC_STATUS_END, ARC_STATUS_OUTLINE, ARC_STATUS_START, CrossProduct(), EuclideanNorm(), HitTestPoints(), IS_MOVED, IS_NEW, IS_RESIZED, m_ArcEnd, m_ArcStart, m_editCenterDistance, m_editDirection, m_editSelectPoint, m_editState, EDA_ITEM::m_Flags, LIB_ITEM::m_initialCursorPos, LIB_ITEM::m_initialPos, m_lastEditState, m_Pos, MINIMUM_SELECTION_DISTANCE, LIB_ITEM::SetEraseLastDrawItem(), twoPointVector(), wxPoint::x, and wxPoint::y.

591 {
592  wxCHECK_RET( ( aEditMode & ( IS_NEW | IS_MOVED | IS_RESIZED ) ) != 0,
593  wxT( "Invalid edit mode for LIB_ARC object." ) );
594 
595  if( aEditMode == IS_NEW )
596  {
597  m_ArcStart = m_ArcEnd = aPosition;
599  }
600  else if( aEditMode == IS_MOVED )
601  {
603  m_initialCursorPos = aPosition;
605  }
606  else
607  {
608  // The arc center point has to be rotated with while adjusting the
609  // start or end point, determine the side of this point and the distance
610  // from the start / end point
611  wxPoint middlePoint = wxPoint( (m_ArcStart.x + m_ArcEnd.x) / 2,
612  (m_ArcStart.y + m_ArcEnd.y) / 2 );
613  wxPoint centerVector = m_Pos - middlePoint;
614  wxPoint startEndVector = twoPointVector( m_ArcStart, m_ArcEnd );
615  m_editCenterDistance = EuclideanNorm( centerVector );
616 
617  // Determine on which side is the center point
618  m_editDirection = CrossProduct( startEndVector, centerVector ) ? 1 : -1;
619 
620  // Drag either the start, end point or the outline
622  {
624  }
625  else if( HitTestPoints( m_ArcEnd, aPosition, MINIMUM_SELECTION_DISTANCE ) )
626  {
628  }
629  else
630  {
632  }
633 
634  m_editState = 0;
636  }
637 
638  m_Flags = aEditMode;
639 }
double EuclideanNorm(const wxPoint &vector)
Euclidean norm of a 2D vector.
Definition: trigo.h:112
static wxPoint twoPointVector(const wxPoint &startPoint, const wxPoint &endPoint)
Definition: lib_arc.cpp:46
double m_editCenterDistance
Definition: lib_arc.h:54
void SetEraseLastDrawItem(bool aErase=true)
#define MINIMUM_SELECTION_DISTANCE
Definition: lib_draw_item.h:52
int m_lastEditState
Definition: lib_arc.h:58
wxPoint m_ArcEnd
Definition: lib_arc.h:51
#define IS_NEW
New item, just created.
Definition: base_struct.h:127
wxPoint m_Pos
Definition: lib_arc.h:52
int m_editState
Definition: lib_arc.h:56
double CrossProduct(const wxPoint &vectorA, const wxPoint &vectorB)
Determine the cross product.
Definition: trigo.h:166
wxPoint m_initialPos
Temporary position when moving an existing item.
bool HitTestPoints(const wxPoint &pointA, const wxPoint &pointB, double threshold)
Test, if two points are near each other.
Definition: trigo.h:150
STATUS_FLAGS m_Flags
Flag bits for editing and other uses.
Definition: base_struct.h:189
#define IS_RESIZED
Item being resized.
Definition: base_struct.h:128
int m_editDirection
Definition: lib_arc.h:57
SELECT_T m_editSelectPoint
Definition: lib_arc.h:55
wxPoint m_ArcStart
Definition: lib_arc.h:50
wxPoint m_initialCursorPos
Initial cursor position at the beginning of a move.
#define IS_MOVED
Item being moved.
Definition: base_struct.h:126
void LIB_ARC::calcEdit ( const wxPoint aPosition)
overrideprivatevirtual

Calculates the center, radius, and angles at aPosition when the arc is being edited.

Note: The center may not necessarily be on the grid.

Parameters
aPosition- The current mouse position in drawing coordinates.

Reimplemented from LIB_ITEM.

Definition at line 674 of file lib_arc.cpp.

References PNS::angle(), ARC_STATUS_END, ARC_STATUS_START, ArcTangente(), calcCenter(), CalcRadiusAngles(), CrossProduct(), DistanceLinePoint(), EuclideanNorm(), IS_MOVED, IS_NEW, IS_RESIZED, m_ArcEnd, m_ArcStart, m_editCenterDistance, m_editDirection, m_editSelectPoint, m_editState, EDA_ITEM::m_Flags, LIB_ITEM::m_initialCursorPos, LIB_ITEM::m_initialPos, m_lastEditState, m_Pos, MINIMUM_SELECTION_DISTANCE, Move(), RotatePoint(), LIB_ITEM::SetEraseLastDrawItem(), twoPointVector(), wxPoint::x, and wxPoint::y.

675 {
676  if( m_Flags == IS_RESIZED )
677  {
678  wxPoint newCenterPoint, startPos, endPos;
679 
680  // Choose the point of the arc to be adjusted
682  {
683  startPos = aPosition;
684  endPos = m_ArcEnd;
685  }
686  else if( m_editSelectPoint == ARC_STATUS_END )
687  {
688  endPos = aPosition;
689  startPos = m_ArcStart;
690  }
691  else
692  {
693  // Use the cursor for adjusting the arc curvature
694  startPos = m_ArcStart;
695  endPos = m_ArcEnd;
696 
697  // If the distance is too small, use the old center point
698  // else the new center point is calculated over the three points start/end/cursor
699  if( DistanceLinePoint( startPos, endPos, aPosition ) > MINIMUM_SELECTION_DISTANCE )
700  {
701  newCenterPoint = calcCenter( startPos, aPosition, endPos );
702  }
703  else
704  {
705  newCenterPoint = m_Pos;
706  }
707 
708  // Determine if the arc angle is larger than 180 degrees -> this happens if both
709  // points (cursor position, center point) lie on the same side of the vector
710  // start-end
711  double crossA = CrossProduct( twoPointVector( startPos, endPos ),
712  twoPointVector( endPos, aPosition ) );
713  double crossB = CrossProduct( twoPointVector( startPos, endPos ),
714  twoPointVector( endPos, newCenterPoint ) );
715 
716  if( ( crossA < 0 && crossB < 0 ) || ( crossA >= 0 && crossB >= 0 ) )
717  newCenterPoint = m_Pos;
718  }
719 
721  {
722  // Compute the new center point when the start/end points are modified
723  wxPoint middlePoint = wxPoint( (startPos.x + endPos.x) / 2,
724  (startPos.y + endPos.y) / 2 );
725 
726  wxPoint startEndVector = twoPointVector( startPos, endPos );
727  wxPoint perpendicularVector = wxPoint( -startEndVector.y, startEndVector.x );
728  double lengthPerpendicularVector = EuclideanNorm( perpendicularVector );
729 
730  // prevent too large values, division / 0
731  if( lengthPerpendicularVector < 1e-1 )
732  lengthPerpendicularVector = 1e-1;
733 
734  perpendicularVector.x = (int) ( (double) perpendicularVector.x *
736  lengthPerpendicularVector ) * m_editDirection;
737  perpendicularVector.y = (int) ( (double) perpendicularVector.y *
739  lengthPerpendicularVector ) * m_editDirection;
740 
741  newCenterPoint = middlePoint + perpendicularVector;
742 
743  m_ArcStart = startPos;
744  m_ArcEnd = endPos;
745  }
746 
747  m_Pos = newCenterPoint;
749  }
750  else if( m_Flags == IS_NEW )
751  {
752  if( m_editState == 1 )
753  {
754  m_ArcEnd = aPosition;
755  }
756 
759 
760  // Keep the arc center point up to date. Otherwise, there will be edit graphic
761  // artifacts left behind from the initial draw.
762  int dx, dy;
763  int cX, cY;
764  double angle;
765 
766  cX = aPosition.x;
767  cY = aPosition.y;
768 
769  dx = m_ArcEnd.x - m_ArcStart.x;
770  dy = m_ArcEnd.y - m_ArcStart.y;
771  cX -= m_ArcStart.x;
772  cY -= m_ArcStart.y;
773  angle = ArcTangente( dy, dx );
774  RotatePoint( &dx, &dy, angle ); /* The segment dx, dy is horizontal
775  * -> Length = dx, dy = 0 */
776  RotatePoint( &cX, &cY, angle );
777  cX = dx / 2; /* cX, cY is on the median segment 0.0 a dx, 0 */
778 
779  RotatePoint( &cX, &cY, -angle );
780  cX += m_ArcStart.x;
781  cY += m_ArcStart.y;
782  m_Pos.x = cX;
783  m_Pos.y = cY;
785 
787  }
788  else if( m_Flags == IS_MOVED )
789  {
790  Move( m_initialPos + aPosition - m_initialCursorPos );
791  }
792 }
double EuclideanNorm(const wxPoint &vector)
Euclidean norm of a 2D vector.
Definition: trigo.h:112
static wxPoint twoPointVector(const wxPoint &startPoint, const wxPoint &endPoint)
Definition: lib_arc.cpp:46
double m_editCenterDistance
Definition: lib_arc.h:54
void SetEraseLastDrawItem(bool aErase=true)
#define MINIMUM_SELECTION_DISTANCE
Definition: lib_draw_item.h:52
int m_lastEditState
Definition: lib_arc.h:58
void CalcRadiusAngles()
Calculate the radius and angle of an arc using the start, end, and center points. ...
Definition: lib_arc.cpp:795
void RotatePoint(int *pX, int *pY, double angle)
Definition: trigo.cpp:317
wxPoint m_ArcEnd
Definition: lib_arc.h:51
#define IS_NEW
New item, just created.
Definition: base_struct.h:127
double ArcTangente(int dy, int dx)
Definition: trigo.cpp:271
wxPoint m_Pos
Definition: lib_arc.h:52
void Move(const wxPoint &aPosition) override
Function Move moves a draw object to aPosition.
Definition: lib_arc.cpp:278
int m_editState
Definition: lib_arc.h:56
double CrossProduct(const wxPoint &vectorA, const wxPoint &vectorB)
Determine the cross product.
Definition: trigo.h:166
wxPoint m_initialPos
Temporary position when moving an existing item.
static DIRECTION_45::AngleType angle(const VECTOR2I &a, const VECTOR2I &b)
STATUS_FLAGS m_Flags
Flag bits for editing and other uses.
Definition: base_struct.h:189
#define IS_RESIZED
Item being resized.
Definition: base_struct.h:128
int m_editDirection
Definition: lib_arc.h:57
SELECT_T m_editSelectPoint
Definition: lib_arc.h:55
wxPoint m_ArcStart
Definition: lib_arc.h:50
static wxPoint calcCenter(const wxPoint &A, const wxPoint &B, const wxPoint &C)
Given three points A B C, compute the circumcenter of the resulting triangle reference: http://en...
Definition: lib_arc.cpp:55
double DistanceLinePoint(const wxPoint &linePointA, const wxPoint &linePointB, const wxPoint &referencePoint)
Compute the distance between a line and a reference point Reference: http://mathworld.wolfram.com/Point-LineDistance2-Dimensional.html.
Definition: trigo.h:129
wxPoint m_initialCursorPos
Initial cursor position at the beginning of a move.
#define IS_MOVED
Item being moved.
Definition: base_struct.h:126
void LIB_ARC::CalcRadiusAngles ( )

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

Definition at line 795 of file lib_arc.cpp.

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

796 {
797  wxPoint centerStartVector = twoPointVector( m_Pos, m_ArcStart );
798  wxPoint centerEndVector = twoPointVector( m_Pos, m_ArcEnd );
799 
800  m_Radius = KiROUND( EuclideanNorm( centerStartVector ) );
801 
802  // Angles in eeschema are still integers
803  m_t1 = KiROUND( ArcTangente( centerStartVector.y, centerStartVector.x ) );
804  m_t2 = KiROUND( ArcTangente( centerEndVector.y, centerEndVector.x ) );
805 
807  NORMALIZE_ANGLE_POS( m_t2 ); // angles = 0 .. 3600
808 
809  // Restrict angle to less than 180 to avoid PBS display mirror Trace because it is
810  // assumed that the arc is less than 180 deg to find orientation after rotate or mirror.
811  if( (m_t2 - m_t1) > 1800 )
812  m_t2 -= 3600;
813  else if( (m_t2 - m_t1) <= -1800 )
814  m_t2 += 3600;
815 
816  while( (m_t2 - m_t1) >= 1800 )
817  {
818  m_t2--;
819  m_t1++;
820  }
821 
822  while( (m_t1 - m_t2) >= 1800 )
823  {
824  m_t2++;
825  m_t1--;
826  }
827 
829 
830  if( !IsMoving() )
832 }
double EuclideanNorm(const wxPoint &vector)
Euclidean norm of a 2D vector.
Definition: trigo.h:112
int m_Radius
Definition: lib_arc.h:47
static wxPoint twoPointVector(const wxPoint &startPoint, const wxPoint &endPoint)
Definition: lib_arc.cpp:46
bool IsMoving() const
Definition: base_struct.h:232
int m_t1
Definition: lib_arc.h:48
static int KiROUND(double v)
KiROUND rounds a floating point number to an int using "round halfway cases away from zero"...
Definition: common.h:107
int m_t2
Definition: lib_arc.h:49
wxPoint m_ArcEnd
Definition: lib_arc.h:51
void NORMALIZE_ANGLE_POS(T &Angle)
Definition: trigo.h:230
double ArcTangente(int dy, int dx)
Definition: trigo.cpp:271
wxPoint m_Pos
Definition: lib_arc.h:52
wxPoint m_ArcStart
Definition: lib_arc.h:50
void EDA_ITEM::ClearBrightened ( )
inlineinherited

Definition at line 247 of file base_struct.h.

References BRIGHTENED, and EDA_ITEM::ClearFlags().

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

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

Definition at line 268 of file base_struct.h.

Referenced by Abort_Edit_Pcb_Text(), Abort_EditEdge(), Abort_Move_ModuleOutline(), Abort_Move_Pad(), Abort_MoveOrCopyModule(), Abort_MoveTrack(), Abort_Zone_Create_Outline(), Abort_Zone_Move_Corner_Or_Outlines(), AbortMoveAndEditTarget(), abortMoveBitmap(), AbortMoveDimensionText(), abortMoveItem(), AbortMoveTextModule(), AbortPinMove(), SCH_SCREEN::addConnectedItemsToBlock(), SCH_EDIT_FRAME::addCurrentItemToList(), PNS_KICAD_IFACE::AddItem(), PCB_EDIT_FRAME::AppendBoardFile(), SCH_EDIT_FRAME::AppendOneEEProject(), PCB_EDIT_FRAME::Begin_DrawSegment(), FOOTPRINT_EDIT_FRAME::Begin_Edge_Module(), PCB_EDIT_FRAME::Begin_Zone(), SCH_EDIT_FRAME::BeginSegment(), PCB_EDIT_FRAME::Block_Delete(), PCB_EDIT_FRAME::Block_Flip(), PCB_EDIT_FRAME::Block_Move(), PCB_EDIT_FRAME::Change_Side_Module(), SCH_SCREEN::ClearAnnotation(), EDA_ITEM::ClearBrightened(), EDA_ITEM::ClearHighlighted(), ClearMarkItems(), clearModuleItemFlags(), EDA_ITEM::ClearSelected(), SCH_EDIT_FRAME::ConvertPart(), SCH_EDIT_FRAME::copyBlockItems(), CopyMarkedItems(), DIALOG_EDIT_COMPONENT_IN_SCHEMATIC::copyPanelToOptions(), MWAVE::CreateMicrowaveInductor(), FOOTPRINT_EDIT_FRAME::CreateTextModule(), PCB_EDIT_FRAME::Delete_LastCreatedCorner(), PCB_EDIT_FRAME::Delete_Segment_Edge(), LIB_PART::DeleteSelectedItems(), DIALOG_LIB_EDIT_PIN::DIALOG_LIB_EDIT_PIN(), PCB_EDIT_FRAME::EditDimension(), PCB_EDIT_FRAME::End_Edge(), FOOTPRINT_EDIT_FRAME::End_Edge_Module(), PCB_EDIT_FRAME::End_Move_Zone_Corner_Or_Outlines(), PCB_EDIT_FRAME::End_Zone(), SCH_EDIT_FRAME::EndSegment(), PCB_EDIT_FRAME::Exchange_Module(), ExitSheet(), SCH_SCREEN::GetConnection(), PCB_BASE_FRAME::GlobalChange_PadSettings(), PCB_BASE_FRAME::Import_Pad_Settings(), SCH_JUNCTION::IsSelectStateChanged(), SCH_NO_CONNECT::IsSelectStateChanged(), SCH_MARKER::IsSelectStateChanged(), SCH_BUS_ENTRY_BASE::IsSelectStateChanged(), SCH_LINE::IsSelectStateChanged(), SCH_BITMAP::IsSelectStateChanged(), SCH_TEXT::IsSelectStateChanged(), SCH_SHEET::IsSelectStateChanged(), SCH_COMPONENT::IsSelectStateChanged(), FOOTPRINT_EDIT_FRAME::Load_Module_From_BOARD(), SCH_EAGLE_PLUGIN::loadSheet(), MarkItemsInBloc(), MirrorX(), MirrorY(), moveBitmap(), FOOTPRINT_EDIT_FRAME::OnEditItemRequest(), LIB_EDIT_FRAME::OnEditPin(), FOOTPRINT_EDIT_FRAME::OnLeftClick(), SCH_EDIT_FRAME::OnLeftClick(), PCB_EDIT_FRAME::OnLeftClick(), LIB_EDIT_FRAME::OnRotateItem(), SCH_EDIT_FRAME::OnSelectUnit(), FOOTPRINT_EDIT_FRAME::OpenProjectFiles(), SCH_FIELD::Place(), PCB_EDIT_FRAME::Place_DrawItem(), FOOTPRINT_EDIT_FRAME::Place_EdgeMod(), PCB_EDIT_FRAME::Place_Texte_Pcb(), PCB_EDIT_FRAME::PlaceDimensionText(), PCB_EDIT_FRAME::PlaceDraggedOrMovedTrackSegment(), PCB_BASE_FRAME::PlaceModule(), PCB_BASE_FRAME::PlacePad(), PCB_EDIT_FRAME::PlaceTarget(), DRAWING_TOOL::PlaceText(), PCB_BASE_FRAME::PlaceTexteModule(), FOOTPRINT_EDIT_FRAME::Process_Special_Functions(), LIB_EDIT_FRAME::Process_Special_Functions(), EDIT_TOOL::Properties(), BOARD_COMMIT::Push(), PCB_BASE_EDIT_FRAME::PutDataInPreviousState(), SCH_EDIT_FRAME::PutDataInPreviousState(), SCH_EDIT_FRAME::RepeatDrawItem(), LIB_EDIT_FRAME::RepeatPinItem(), BOARD_COMMIT::Revert(), PCB_BASE_FRAME::Rotate_Module(), RotateListOfItems(), LIB_PIN::Save(), PCB_BASE_EDIT_FRAME::SaveCopyInUndoList(), FOOTPRINT_VIEWER_FRAME::SelectCurrentFootprint(), SCH_EDIT_FRAME::SetRepeatItem(), PCB_EDIT_FRAME::Start_DragTrackSegmentAndKeepSlope(), PCB_EDIT_FRAME::StartMoveModule(), PCB_EDIT_FRAME::StartMoveOneNodeOrSegment(), and DIALOG_PAD_PROPERTIES::TransferDataFromWindow().

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

Definition at line 246 of file base_struct.h.

References EDA_ITEM::ClearFlags(), and HIGHLIGHTED.

246 { ClearFlags( HIGHLIGHTED ); }
#define HIGHLIGHTED
item is drawn in normal colors, when the rest is darkened
Definition: base_struct.h:150
void ClearFlags(STATUS_FLAGS aMask=EDA_ITEM_ALL_FLAGS)
Definition: base_struct.h:268
void EDA_ITEM::ClearSelected ( )
inlineinherited
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 235 of file lib_arc.cpp.

References LIB_ARC().

236 {
237  return new LIB_ARC( *this );
238 }
LIB_ARC(LIB_PART *aParent)
Definition: lib_arc.cpp:88
int LIB_ARC::compare ( const LIB_ITEM aOther) const
overrideprivatevirtual

Function compare provides the draw object specific comparison called by the == and < operators.

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

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

The arc specific sort order is as follows:

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

Implements LIB_ITEM.

Definition at line 241 of file lib_arc.cpp.

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

242 {
243  wxASSERT( aOther.Type() == LIB_ARC_T );
244 
245  const LIB_ARC* tmp = ( LIB_ARC* ) &aOther;
246 
247  if( m_Pos.x != tmp->m_Pos.x )
248  return m_Pos.x - tmp->m_Pos.x;
249 
250  if( m_Pos.y != tmp->m_Pos.y )
251  return m_Pos.y - tmp->m_Pos.y;
252 
253  if( m_t1 != tmp->m_t1 )
254  return m_t1 - tmp->m_t1;
255 
256  if( m_t2 != tmp->m_t2 )
257  return m_t2 - tmp->m_t2;
258 
259  return 0;
260 }
KICAD_T Type() const
Function Type()
Definition: base_struct.h:212
int m_t1
Definition: lib_arc.h:48
int m_t2
Definition: lib_arc.h:49
wxPoint m_Pos
Definition: lib_arc.h:52
bool LIB_ARC::ContinueEdit ( const wxPoint  aPosition)
overridevirtual

Continue an edit in progress at aPosition.

This is used to perform the next action while editing a draw item. This would be called for each additional left click when the mouse is captured while the item is being edited.

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

Definition at line 642 of file lib_arc.cpp.

References IS_MOVED, IS_NEW, IS_RESIZED, m_ArcEnd, m_editState, EDA_ITEM::m_Flags, and LIB_ITEM::SetEraseLastDrawItem().

643 {
644  wxCHECK_MSG( ( m_Flags & ( IS_NEW | IS_MOVED | IS_RESIZED ) ) != 0, false,
645  wxT( "Bad call to ContinueEdit(). LIB_ARC is not being edited." ) );
646 
647  if( m_Flags == IS_NEW )
648  {
649  if( m_editState == 1 ) // Second position yields the arc segment length.
650  {
651  m_ArcEnd = aPosition;
652  m_editState = 2;
653  SetEraseLastDrawItem( false );
654  return true; // Need third position to calculate center point.
655  }
656  }
657 
658  return false;
659 }
void SetEraseLastDrawItem(bool aErase=true)
wxPoint m_ArcEnd
Definition: lib_arc.h:51
#define IS_NEW
New item, just created.
Definition: base_struct.h:127
int m_editState
Definition: lib_arc.h:56
STATUS_FLAGS m_Flags
Flag bits for editing and other uses.
Definition: base_struct.h:189
#define IS_RESIZED
Item being resized.
Definition: base_struct.h:128
#define IS_MOVED
Item being moved.
Definition: base_struct.h:126
void LIB_ITEM::Draw ( EDA_DRAW_PANEL aPanel,
wxDC *  aDC,
const wxPoint aOffset,
COLOR4D  aColor,
GR_DRAWMODE  aDrawMode,
void *  aData,
const TRANSFORM aTransform 
)
virtualinherited

Draw an item.

Parameters
aPanelDrawPanel to use (can be null) mainly used for clipping purposes.
aDCDevice Context (can be null)
aOffsetOffset to draw
aColorDraw color, or COLOR4D::UNSPECIFIED to use the normal body item color
aDrawModeGR_OR, GR_XOR, ...
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 117 of file lib_draw_item.cpp.

References LIB_ITEM::calcEdit(), color, LIB_ITEM::drawEditGraphics(), LIB_ITEM::drawGraphic(), g_XorMode, EDA_DRAW_PANEL::GetClipBox(), LIB_ITEM::GetDefaultColor(), GRSetDrawMode(), LIB_ITEM::InEditMode(), LIB_ITEM::m_eraseLastDrawItem, LIB_ITEM::m_Fill, and NO_FILL.

Referenced by LIB_EDIT_FRAME::CreatePin(), DrawMovePin(), LIB_EDIT_FRAME::EditSymbolText(), LIB_EDIT_FRAME::GraphicItemBeginDraw(), DIALOG_LIB_EDIT_PIN::OnPaintShowPanel(), LIB_EDIT_FRAME::Process_Special_Functions(), RedrawWhileMovingCursor(), LIB_PART::RemoveDrawItem(), and SymbolDisplayDraw().

121 {
122  if( InEditMode() )
123  {
124  // Temporarily disable filling while the item is being edited.
125  FILL_T fillMode = m_Fill;
127 
128  m_Fill = NO_FILL;
129 
130 #ifndef USE_WX_OVERLAY
131  // Erase the old items using the previous attributes.
132  if( m_eraseLastDrawItem )
133  {
134  GRSetDrawMode( aDC, g_XorMode );
135  drawEditGraphics( aPanel->GetClipBox(), aDC, color );
136  drawGraphic( aPanel, aDC, wxPoint( 0, 0 ), color, g_XorMode, aData,
137  aTransform );
138  }
139 #endif
140  // Calculate the new attributes at the current cursor position.
141  calcEdit( aOffset );
142 
143  // Draw the items using the new attributes.
144  drawEditGraphics( aPanel->GetClipBox(), aDC, color );
145  drawGraphic( aPanel, aDC, wxPoint( 0, 0 ), color, g_XorMode, aData,
146  aTransform );
147 
148  m_Fill = fillMode;
149  }
150  else
151  {
152  drawGraphic( aPanel, aDC, aOffset, aColor, aDrawMode, aData, aTransform );
153  }
154 }
GR_DRAWMODE g_XorMode
Definition: gr_basic.cpp:51
void GRSetDrawMode(wxDC *DC, GR_DRAWMODE draw_mode)
Definition: gr_basic.cpp:290
virtual COLOR4D GetDefaultColor()
bool m_eraseLastDrawItem
Used when editing a new draw item to prevent drawing artifacts.
bool InEditMode() const
Return the draw item editing mode status.
virtual void calcEdit(const wxPoint &aPosition)
Calculates the attributes of an item at aPosition when it is being edited.
virtual void drawEditGraphics(EDA_RECT *aClipBox, wxDC *aDC, COLOR4D aColor)
Draw any editing specific graphics when the item is being edited.
Definition: lib_draw_item.h:96
EDA_RECT * GetClipBox()
virtual void drawGraphic(EDA_DRAW_PANEL *aPanel, wxDC *aDC, const wxPoint &aOffset, COLOR4D aColor, GR_DRAWMODE aDrawMode, void *aData, const TRANSFORM &aTransform)=0
Function drawGraphic.
FILL_T m_Fill
The body fill type.
FILL_T
Enum FILL_T is the set of fill types used in plotting or drawing enclosed areas.
Definition: base_struct.h:70
Class COLOR4D is the color representation with 4 components: red, green, blue, alpha.
Definition: color4d.h:39
void LIB_ARC::drawEditGraphics ( EDA_RECT aClipBox,
wxDC *  aDC,
COLOR4D  aColor 
)
overrideprivatevirtual

Draw the graphics when the arc is being edited.

Reimplemented from LIB_ITEM.

Definition at line 392 of file lib_arc.cpp.

References GRDashedLine(), GRLine(), EDA_ITEM::IsNew(), m_ArcEnd, m_ArcStart, m_lastEditState, m_Pos, wxPoint::x, and wxPoint::y.

393 {
394  // The edit indicators only get drawn when a new arc is being drawn.
395  if( !IsNew() )
396  return;
397 
398  // Use the last edit state so when the drawing switches from the end mode to the center
399  // point mode, the last line between the center points gets erased.
400  if( m_lastEditState == 1 )
401  {
402  GRLine( aClipBox, aDC, m_ArcStart.x, -m_ArcStart.y, m_ArcEnd.x, -m_ArcEnd.y, 0, aColor );
403  }
404  else
405  {
406  GRDashedLine( aClipBox, aDC, m_ArcStart.x, -m_ArcStart.y, m_Pos.x, -m_Pos.y, 0, aColor );
407  GRDashedLine( aClipBox, aDC, m_ArcEnd.x, -m_ArcEnd.y, m_Pos.x, -m_Pos.y, 0, aColor );
408  }
409 }
bool IsNew() const
Definition: base_struct.h:230
void GRLine(EDA_RECT *ClipBox, wxDC *DC, int x1, int y1, int x2, int y2, int width, COLOR4D Color)
Definition: gr_basic.cpp:352
int m_lastEditState
Definition: lib_arc.h:58
wxPoint m_ArcEnd
Definition: lib_arc.h:51
wxPoint m_Pos
Definition: lib_arc.h:52
void GRDashedLine(EDA_RECT *ClipBox, wxDC *DC, int x1, int y1, int x2, int y2, int width, COLOR4D Color)
Definition: gr_basic.cpp:374
wxPoint m_ArcStart
Definition: lib_arc.h:50
void LIB_ARC::drawGraphic ( EDA_DRAW_PANEL aPanel,
wxDC *  aDC,
const wxPoint aOffset,
COLOR4D  aColor,
GR_DRAWMODE  aDrawMode,
void *  aData,
const TRANSFORM aTransform 
)
overrideprivatevirtual

Draws the arc.

Implements LIB_ITEM.

Definition at line 412 of file lib_arc.cpp.

References color, FILLED_SHAPE, FILLED_WITH_BG_BODYCOLOR, GetBoundingBox(), EDA_DRAW_PANEL::GetClipBox(), GetItemSelectedColor(), GetLayerColor(), GetPenSize(), GRArc(), GRArc1(), GRFilledArc(), GRRect(), GRSetDrawMode(), IS_MOVED, EDA_ITEM::IsNew(), EDA_ITEM::IsSelected(), LAYER_DEVICE, LAYER_DEVICE_BACKGROUND, LIGHTMAGENTA, m_ArcEnd, m_ArcStart, LIB_ITEM::m_Fill, EDA_ITEM::m_Flags, m_lastEditState, m_Pos, m_Radius, m_t1, m_t2, TRANSFORM::MapAngles(), EDA_RECT::Move(), NO_FILL, EDA_RECT::RevertYAxis(), TRANSFORM::TransformCoordinate(), wxPoint::x, and wxPoint::y.

415 {
416  // Don't draw the arc until the end point is selected. Only the edit indicators
417  // get drawn at this time.
418  if( IsNew() && m_lastEditState == 1 )
419  return;
420 
421  wxPoint pos1, pos2, posc;
423 
424  if( aColor == COLOR4D::UNSPECIFIED ) // Used normal color or selected color
425  {
426  if( IsSelected() )
427  color = GetItemSelectedColor();
428  }
429  else
430  {
431  color = aColor;
432  }
433 
434  pos1 = aTransform.TransformCoordinate( m_ArcEnd ) + aOffset;
435  pos2 = aTransform.TransformCoordinate( m_ArcStart ) + aOffset;
436  posc = aTransform.TransformCoordinate( m_Pos ) + aOffset;
437  int pt1 = m_t1;
438  int pt2 = m_t2;
439  bool swap = aTransform.MapAngles( &pt1, &pt2 );
440 
441  if( swap )
442  {
443  std::swap( pos1.x, pos2.x );
444  std::swap( pos1.y, pos2.y );
445  }
446 
447  GRSetDrawMode( aDC, aDrawMode );
448 
449  FILL_T fill = aData ? NO_FILL : m_Fill;
450 
451  if( aColor != COLOR4D::UNSPECIFIED )
452  fill = NO_FILL;
453 
454  EDA_RECT* const clipbox = aPanel? aPanel->GetClipBox() : NULL;
455 
456  if( fill == FILLED_WITH_BG_BODYCOLOR )
457  {
458  GRFilledArc( clipbox, aDC, posc.x, posc.y, pt1, pt2,
459  m_Radius, GetPenSize( ),
462  }
463  else if( fill == FILLED_SHAPE && !aData )
464  {
465  GRFilledArc( clipbox, aDC, posc.x, posc.y, pt1, pt2, m_Radius,
466  color, color );
467  }
468  else
469  {
470 
471 #ifdef DRAW_ARC_WITH_ANGLE
472 
473  GRArc( clipbox, aDC, posc.x, posc.y, pt1, pt2, m_Radius,
474  GetPenSize(), color );
475 #else
476 
477  GRArc1( clipbox, aDC, pos1.x, pos1.y, pos2.x, pos2.y,
478  posc.x, posc.y, GetPenSize(), color );
479 #endif
480  }
481 
482  /* Set to one (1) to draw bounding box around arc to validate bounding box
483  * calculation. */
484 #if 0
485  EDA_RECT bBox = GetBoundingBox();
486  bBox.RevertYAxis();
487  bBox = aTransform.TransformCoordinate( bBox );
488  bBox.Move( aOffset );
489  GRRect( clipbox, aDC, bBox, 0, LIGHTMAGENTA );
490 #endif
491 }
int m_Radius
Definition: lib_arc.h:47
int m_t1
Definition: lib_arc.h:48
void Move(const wxPoint &aMoveVector)
Function Move moves the rectangle by the aMoveVector.
void GRSetDrawMode(wxDC *DC, GR_DRAWMODE draw_mode)
Definition: gr_basic.cpp:290
bool IsNew() const
Definition: base_struct.h:230
int m_t2
Definition: lib_arc.h:49
int m_lastEditState
Definition: lib_arc.h:58
const EDA_RECT GetBoundingBox() const override
Definition: lib_arc.cpp:494
bool IsSelected() const
Definition: base_struct.h:235
wxPoint m_ArcEnd
Definition: lib_arc.h:51
COLOR4D GetLayerColor(SCH_LAYER_ID aLayer)
Definition: eeschema.cpp:167
void RevertYAxis()
Function RevertYAxis Mirror the rectangle from the X axis (negate Y pos and size) ...
wxPoint TransformCoordinate(const wxPoint &aPoint) const
Calculate a new coordinate according to the mirror/rotation transform.
Definition: transform.cpp:41
void GRRect(EDA_RECT *aClipBox, wxDC *aDC, int x1, int y1, int x2, int y2, COLOR4D aColor)
Definition: gr_basic.cpp:1077
bool MapAngles(int *aAngle1, int *aAngle2) const
Calculate new angles according to the transform.
Definition: transform.cpp:80
wxPoint m_Pos
Definition: lib_arc.h:52
void GRArc(EDA_RECT *ClipBox, wxDC *DC, int xc, int yc, double StAngle, double EndAngle, int r, COLOR4D Color)
Definition: gr_basic.cpp:982
EDA_RECT * GetClipBox()
int GetPenSize() const override
Function GetPenSize.
Definition: lib_arc.cpp:386
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:922
FILL_T m_Fill
The body fill type.
STATUS_FLAGS m_Flags
Flag bits for editing and other uses.
Definition: base_struct.h:189
Class EDA_RECT handles the component boundary box.
FILL_T
Enum FILL_T is the set of fill types used in plotting or drawing enclosed areas.
Definition: base_struct.h:70
COLOR4D GetItemSelectedColor()
wxPoint m_ArcStart
Definition: lib_arc.h:50
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:873
Class COLOR4D is the color representation with 4 components: red, green, blue, alpha.
Definition: color4d.h:39
#define IS_MOVED
Item being moved.
Definition: base_struct.h:126
void LIB_ARC::EndEdit ( const wxPoint aPosition,
bool  aAbort = false 
)
overridevirtual

End an object editing action.

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

Parameters
aPositionThe position of the last edit event in drawing coordinates.
aAbortSet to true to abort the current edit in progress.

Reimplemented from LIB_ITEM.

Definition at line 662 of file lib_arc.cpp.

References IS_MOVED, IS_NEW, IS_RESIZED, m_editState, EDA_ITEM::m_Flags, m_lastEditState, and LIB_ITEM::SetEraseLastDrawItem().

663 {
664  wxCHECK_RET( ( m_Flags & ( IS_NEW | IS_MOVED | IS_RESIZED ) ) != 0,
665  wxT( "Bad call to EndEdit(). LIB_ARC is not being edited." ) );
666 
667  SetEraseLastDrawItem( false );
668  m_lastEditState = 0;
669  m_editState = 0;
670  m_Flags = 0;
671 }
void SetEraseLastDrawItem(bool aErase=true)
int m_lastEditState
Definition: lib_arc.h:58
#define IS_NEW
New item, just created.
Definition: base_struct.h:127
int m_editState
Definition: lib_arc.h:56
STATUS_FLAGS m_Flags
Flag bits for editing and other uses.
Definition: base_struct.h:189
#define IS_RESIZED
Item being resized.
Definition: base_struct.h:128
#define IS_MOVED
Item being moved.
Definition: base_struct.h:126
const EDA_RECT LIB_ARC::GetBoundingBox ( ) const
overridevirtual
Returns
the boundary box for this, in library coordinates

Reimplemented from LIB_ITEM.

Definition at line 494 of file lib_arc.cpp.

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

Referenced by drawGraphic(), and GetMsgPanelInfo().

495 {
496  int minX, minY, maxX, maxY, angleStart, angleEnd;
497  EDA_RECT rect;
498  wxPoint nullPoint, startPos, endPos, centerPos;
499  wxPoint normStart = m_ArcStart - m_Pos;
500  wxPoint normEnd = m_ArcEnd - m_Pos;
501 
502  if( ( normStart == nullPoint ) || ( normEnd == nullPoint ) || ( m_Radius == 0 ) )
503  {
504  wxLogDebug( wxT("Invalid arc drawing definition, center(%d, %d) \
505 start(%d, %d), end(%d, %d), radius %d" ),
506  m_Pos.x, m_Pos.y, m_ArcStart.x, m_ArcStart.y, m_ArcEnd.x,
507  m_ArcEnd.y, m_Radius );
508  return rect;
509  }
510 
513  centerPos = DefaultTransform.TransformCoordinate( m_Pos );
514  angleStart = m_t1;
515  angleEnd = m_t2;
516 
517  if( DefaultTransform.MapAngles( &angleStart, &angleEnd ) )
518  {
519  std::swap( endPos.x, startPos.x );
520  std::swap( endPos.y, startPos.y );
521  }
522 
523  /* Start with the start and end point of the arc. */
524  minX = std::min( startPos.x, endPos.x );
525  minY = std::min( startPos.y, endPos.y );
526  maxX = std::max( startPos.x, endPos.x );
527  maxY = std::max( startPos.y, endPos.y );
528 
529  /* Zero degrees is a special case. */
530  if( angleStart == 0 )
531  maxX = centerPos.x + m_Radius;
532 
533  /* Arc end angle wrapped passed 360. */
534  if( angleStart > angleEnd )
535  angleEnd += 3600;
536 
537  if( angleStart <= 900 && angleEnd >= 900 ) /* 90 deg */
538  maxY = centerPos.y + m_Radius;
539 
540  if( angleStart <= 1800 && angleEnd >= 1800 ) /* 180 deg */
541  minX = centerPos.x - m_Radius;
542 
543  if( angleStart <= 2700 && angleEnd >= 2700 ) /* 270 deg */
544  minY = centerPos.y - m_Radius;
545 
546  if( angleStart <= 3600 && angleEnd >= 3600 ) /* 0 deg */
547  maxX = centerPos.x + m_Radius;
548 
549  rect.SetOrigin( minX, minY );
550  rect.SetEnd( maxX, maxY );
551  rect.Inflate( ( GetPenSize()+1 ) / 2 );
552 
553  return rect;
554 }
int m_Radius
Definition: lib_arc.h:47
int m_t1
Definition: lib_arc.h:48
int m_t2
Definition: lib_arc.h:49
void SetOrigin(const wxPoint &pos)
wxPoint m_ArcEnd
Definition: lib_arc.h:51
wxPoint TransformCoordinate(const wxPoint &aPoint) const
Calculate a new coordinate according to the mirror/rotation transform.
Definition: transform.cpp:41
bool MapAngles(int *aAngle1, int *aAngle2) const
Calculate new angles according to the transform.
Definition: transform.cpp:80
wxPoint m_Pos
Definition: lib_arc.h:52
void SetEnd(int x, int y)
int GetPenSize() const override
Function GetPenSize.
Definition: lib_arc.cpp:386
TRANSFORM DefaultTransform
Definition: eeschema.cpp:58
#define max(a, b)
Definition: auxiliary.h:86
Class EDA_RECT handles the component boundary box.
wxPoint m_ArcStart
Definition: lib_arc.h:50
EDA_RECT & Inflate(wxCoord dx, wxCoord dy)
Function Inflate inflates the rectangle horizontally by dx and vertically by dy.
#define min(a, b)
Definition: auxiliary.h:85
wxString LIB_ARC::GetClass ( ) const
inlineoverridevirtual

Function GetClass returns the class name.

Returns
wxString

Implements EDA_ITEM.

Definition at line 89 of file lib_arc.h.

90  {
91  return wxT( "LIB_ARC" );
92  }
int LIB_ITEM::GetConvert ( ) const
inlineinherited
COLOR4D LIB_ITEM::GetDefaultColor ( )
virtualinherited

Reimplemented in LIB_FIELD.

Definition at line 157 of file lib_draw_item.cpp.

References GetLayerColor(), and LAYER_DEVICE.

Referenced by LIB_ITEM::Draw(), LIB_TEXT::drawGraphic(), and LIB_TEXT::Plot().

158 {
159  return GetLayerColor( LAYER_DEVICE );
160 }
COLOR4D GetLayerColor(SCH_LAYER_ID aLayer)
Definition: eeschema.cpp:167
FILL_T LIB_ITEM::GetFillMode ( ) const
inlineinherited

Definition at line 411 of file lib_draw_item.h.

References LIB_ITEM::m_Fill.

Referenced by LIB_EDIT_FRAME::EditGraphicSymbol().

411 { return m_Fill; }
FILL_T m_Fill
The body fill type.
int LIB_ARC::GetFirstRadiusAngle ( ) const
inline

Definition at line 142 of file lib_arc.h.

References m_t1.

142 { return m_t1; }
int m_t1
Definition: lib_arc.h:48
STATUS_FLAGS EDA_ITEM::GetFlags ( ) const
inlineinherited

Definition at line 269 of file base_struct.h.

References EDA_ITEM::m_Flags.

Referenced by AbortMoveAndEditTarget(), SCH_SCREEN::addConnectedItemsToBlock(), AddMenusForBitmap(), AddMenusForBusEntry(), AddMenusForComponent(), AddMenusForComponentField(), AddMenusForEditComponent(), AddMenusForGLabel(), AddMenusForHierchicalSheet(), AddMenusForHLabel(), AddMenusForLabel(), AddMenusForSheetPin(), AddMenusForText(), SCH_EDIT_FRAME::BeginSegment(), SCH_EDIT_FRAME::ChangeTextOrient(), Collect_TrackSegmentsToDrag(), SCH_EDIT_FRAME::ConvertPart(), DIALOG_EDIT_COMPONENT_IN_SCHEMATIC::copyPanelToOptions(), LIB_EDIT_FRAME::CreatePin(), PCB_EDIT_FRAME::createPopUpMenuForFootprints(), PCB_EDIT_FRAME::createPopUpMenuForFpPads(), PCB_EDIT_FRAME::createPopUpMenuForFpTexts(), PCB_EDIT_FRAME::createPopUpMenuForTexts(), PCB_EDIT_FRAME::createPopupMenuForTracks(), PCB_EDIT_FRAME::createPopUpMenuForZones(), PCB_EDIT_FRAME::Delete_Segment_Edge(), BOARD::Draw(), PCB_EDIT_FRAME::Edit_TrackSegm_Width(), SCH_EDIT_FRAME::EditComponentFieldText(), SCH_EDIT_FRAME::EditImage(), PCB_EDIT_FRAME::FlipTextePcb(), LIB_VIEW_FRAME::GeneralControl(), SCH_EDIT_FRAME::GeneralControl(), SCH_SCREEN::GetConnection(), InitialiseDragParameters(), EDA_DRAW_FRAME::isBusy(), LIB_EDIT_FRAME::LoadOneSymbol(), Magnetize(), SCH_EDIT_FRAME::MirrorImage(), SCH_EDIT_FRAME::MirrorSheet(), moveBitmap(), SCH_EDIT_FRAME::OnAutoplaceFields(), SCH_EDIT_FRAME::OnConvertTextType(), SCH_EDIT_FRAME::OnCopySchematicItemRequest(), SCH_EDIT_FRAME::OnDragItem(), SCH_EDIT_FRAME::OnEditItem(), LIB_EDIT_FRAME::OnEditPin(), FOOTPRINT_EDIT_FRAME::OnHotKey(), SCH_EDIT_FRAME::OnHotKey(), PCB_EDIT_FRAME::OnHotKey(), PCB_EDIT_FRAME::OnHotkeyBeginRoute(), PCB_EDIT_FRAME::OnHotkeyCopyItem(), PCB_EDIT_FRAME::OnHotkeyDeleteItem(), PCB_EDIT_FRAME::OnHotkeyDuplicateOrArrayItem(), PCB_EDIT_FRAME::OnHotkeyEditItem(), PCB_EDIT_FRAME::OnHotkeyFlipItem(), PCB_EDIT_FRAME::OnHotkeyMoveItem(), PCB_EDIT_FRAME::OnHotkeyPlaceItem(), PCB_EDIT_FRAME::OnHotkeyRotateItem(), FOOTPRINT_EDIT_FRAME::OnLeftClick(), SCH_EDIT_FRAME::OnLeftClick(), PCB_EDIT_FRAME::OnLeftClick(), FOOTPRINT_EDIT_FRAME::OnLeftDClick(), SCH_EDIT_FRAME::OnLeftDClick(), PCB_EDIT_FRAME::OnLeftDClick(), SCH_EDIT_FRAME::OnMoveItem(), DIALOG_EDIT_COMPONENT_IN_SCHEMATIC::OnOKButtonClick(), TARGET_PROPERTIES_DIALOG_EDITOR::OnOkClick(), SCH_EDIT_FRAME::OnOpenLibraryEditor(), SCH_EDIT_FRAME::OnOrient(), FOOTPRINT_EDIT_FRAME::OnRightClick(), GERBVIEW_FRAME::OnRightClick(), SCH_EDIT_FRAME::OnRightClick(), PCB_EDIT_FRAME::OnRightClick(), SCH_EDIT_FRAME::OnRotate(), SCH_EDIT_FRAME::OnSelectUnit(), PCB_EDIT_FRAME::PlaceTarget(), FOOTPRINT_EDIT_FRAME::PrepareItemForHotkey(), LIB_EDIT_FRAME::Process_Special_Functions(), EDIT_TOOL::Properties(), TRACKS_CLEANER::removeDuplicatesOfTrack(), PCB_BASE_FRAME::Rotate_Module(), PCB_EDIT_FRAME::Rotate_Texte_Pcb(), SCH_EDIT_FRAME::RotateField(), SCH_EDIT_FRAME::RotateHierarchicalSheet(), SCH_EDIT_FRAME::RotateImage(), PCB_BASE_FRAME::RotateTextModule(), SCH_EDIT_FRAME::SaveCopyInUndoList(), SCH_SCREEN::SelectBlockItems(), SCH_EDIT_FRAME::SetBusEntryShape(), DIALOG_EDIT_COMPONENT_IN_SCHEMATIC::SetInitCmp(), Show_Drag_Track_Segment_With_Cte_Slope(), Show_MoveNode(), PCB_EDIT_FRAME::Start_DragTrackSegmentAndKeepSlope(), PCB_EDIT_FRAME::StartMoveOneNodeOrSegment(), DIALOG_LABEL_EDITOR::TextPropertiesAccept(), DIALOG_PCB_TEXT_PROPERTIES::TransferDataFromWindow(), and DIALOG_MODULE_BOARD_EDITOR::TransferDataFromWindow().

269 { return m_Flags; }
STATUS_FLAGS m_Flags
Flag bits for editing and other uses.
Definition: base_struct.h:189
DHEAD* EDA_ITEM::GetList ( ) const
inlineinherited
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 584 of file lib_arc.cpp.

585 {
586  return add_arc_xpm;
587 }
void LIB_ARC::GetMsgPanelInfo ( std::vector< MSG_PANEL_ITEM > &  aList)
overridevirtual

Function GetMsgPanelInfo displays basic info (type, part and convert) about the current item in message panel.

This base function is used to display the information common to the all library items. Call the base class from the derived class or the common information will not be updated in the message panel.

Parameters
aListis the list to populate.

Reimplemented from LIB_ITEM.

Definition at line 557 of file lib_arc.cpp.

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

558 {
559  wxString msg;
560  EDA_RECT bBox = GetBoundingBox();
561 
562  LIB_ITEM::GetMsgPanelInfo( aList );
563 
564  msg = StringFromValue( g_UserUnit, m_Width, true );
565 
566  aList.push_back( MSG_PANEL_ITEM( _( "Line Width" ), msg, BLUE ) );
567 
568  msg.Printf( wxT( "(%d, %d, %d, %d)" ), bBox.GetOrigin().x,
569  bBox.GetOrigin().y, bBox.GetEnd().x, bBox.GetEnd().y );
570 
571  aList.push_back( MSG_PANEL_ITEM( _( "Bounding Box" ), msg, BROWN ) );
572 }
Definition: colors.h:57
wxString StringFromValue(EDA_UNITS_T aUnit, int aValue, bool aAddUnitSymbol)
Function StringFromValue returns the string from aValue according to units (inch, mm ...
Definition: base_units.cpp:203
const EDA_RECT GetBoundingBox() const override
Definition: lib_arc.cpp:494
const wxPoint & GetOrigin() const
const wxPoint GetEnd() const
EDA_UNITS_T g_UserUnit
Global variables definitions.
Definition: common.cpp:56
virtual void GetMsgPanelInfo(std::vector< MSG_PANEL_ITEM > &aList) override
Function GetMsgPanelInfo displays basic info (type, part and convert) about the current item in messa...
Class EDA_RECT handles the component boundary box.
Class EDA_MSG_ITEM is used EDA_MSG_PANEL as the item type for displaying messages.
Definition: msgpanel.h:53
int m_Width
Definition: lib_arc.h:53
Definition: colors.h:62
int LIB_ARC::GetPenSize ( ) const
overridevirtual

Function GetPenSize.

Returns
the size of the "pen" that be used to draw or plot this item

Implements LIB_ITEM.

Definition at line 386 of file lib_arc.cpp.

References GetDefaultLineThickness(), and m_Width.

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

387 {
388  return ( m_Width == 0 ) ? GetDefaultLineThickness() : m_Width;
389 }
int GetDefaultLineThickness()
Default line thickness used to draw/plot items having a default thickness line value (i...
int m_Width
Definition: lib_arc.h:53
wxPoint LIB_ARC::GetPosition ( ) const
inlineoverridevirtual

Function GetPosition returns the current draw object position.

Returns
A wxPoint object containing the position of the object.

Implements LIB_ITEM.

Definition at line 121 of file lib_arc.h.

References m_Pos.

121 { return m_Pos; }
wxPoint m_Pos
Definition: lib_arc.h:52
int LIB_ARC::GetRadius ( ) const
inline

Definition at line 138 of file lib_arc.h.

References m_Radius.

138 { return m_Radius; }
int m_Radius
Definition: lib_arc.h:47
int LIB_ARC::GetSecondRadiusAngle ( ) const
inline

Definition at line 146 of file lib_arc.h.

References m_t2.

146 { return m_t2; }
int m_t2
Definition: lib_arc.h:49
wxString LIB_ARC::GetSelectMenuText ( ) const
overridevirtual

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

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

Returns
The menu text string.

Reimplemented from EDA_ITEM.

Definition at line 575 of file lib_arc.cpp.

References CoordinateToString(), Format(), GetChars(), m_Pos, m_Radius, wxPoint::x, and wxPoint::y.

576 {
577  return wxString::Format( _( "Arc center (%s, %s), radius %s" ),
581 }
int m_Radius
Definition: lib_arc.h:47
wxString CoordinateToString(int aValue, bool aConvertToMils)
Function CoordinateToString is a helper to convert the integer coordinate aValue to a string in inche...
Definition: base_units.cpp:117
wxPoint m_Pos
Definition: lib_arc.h:52
static const wxChar * GetChars(const wxString &s)
Function GetChars returns a wxChar* to the actual wxChar* data within a wxString, and is helpful for ...
Definition: macros.h:92
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
STATUS_FLAGS EDA_ITEM::GetStatus ( ) const
inlineinherited

Definition at line 264 of file base_struct.h.

References EDA_ITEM::m_Status.

Referenced by PCB_IO::format().

264 { return m_Status; }
STATUS_FLAGS m_Status
Definition: base_struct.h:175
wxString LIB_ITEM::GetTypeName ( )
inlineinherited

Definition at line 154 of file lib_draw_item.h.

References LIB_ITEM::m_typeName.

Referenced by LIB_EDIT_FRAME::EditGraphicSymbol().

154 { return m_typeName; }
wxString m_typeName
Name of object displayed in the message panel.
int LIB_ITEM::GetUnit ( ) const
inlineinherited
int LIB_ARC::GetWidth ( ) const
inlineoverridevirtual

Function GetWidth return the width of the draw item.

Returns
Width of draw object.

Implements LIB_ITEM.

Definition at line 132 of file lib_arc.h.

References m_Width.

132 { return m_Width; }
int m_Width
Definition: lib_arc.h:53
bool LIB_ARC::HitTest ( const wxPoint aPosition) const
overridevirtual

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

Parameters
aPositionA reference to a wxPoint object containing the coordinates to test.
Returns
True if aPosition is within or on the item bounding area.

Reimplemented from LIB_ITEM.

Definition at line 178 of file lib_arc.cpp.

References DefaultTransform, GetPenSize(), and MINIMUM_SELECTION_DISTANCE.

179 {
180  int mindist = GetPenSize() / 2;
181 
182  // Have a minimal tolerance for hit test
183  if( mindist < MINIMUM_SELECTION_DISTANCE )
184  mindist = MINIMUM_SELECTION_DISTANCE;
185 
186  return HitTest( aRefPoint, mindist, DefaultTransform );
187 }
#define MINIMUM_SELECTION_DISTANCE
Definition: lib_draw_item.h:52
bool HitTest(const wxPoint &aPosition) const override
Function HitTest tests if aPosition is contained within or on the bounding area of an item...
Definition: lib_arc.cpp:178
int GetPenSize() const override
Function GetPenSize.
Definition: lib_arc.cpp:386
TRANSFORM DefaultTransform
Definition: eeschema.cpp:58
bool LIB_ARC::HitTest ( const wxPoint aPosition,
int  aThreshold,
const TRANSFORM aTransform 
) const
overridevirtual
Parameters
aPositionA wxPoint to test.
aThresholdMaximum distance to this object (usually the half thickness of a line) if < 0, it will be automatically set to half pen size when locating lines or arcs and set to 0 for other items.
aTransformThe transform matrix.
Returns
True if the point aPosition is near this object

Implements LIB_ITEM.

Definition at line 190 of file lib_arc.cpp.

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

191 {
192 
193  if( aThreshold < 0 )
194  aThreshold = GetPenSize() / 2;
195 
196  // TODO: use aTransMat to calculates parameters
197  wxPoint relativePosition = aPosition;
198 
199  relativePosition.y = -relativePosition.y; // reverse Y axis
200 
201  int distance = KiROUND( GetLineLength( m_Pos, relativePosition ) );
202 
203  if( abs( distance - m_Radius ) > aThreshold )
204  return false;
205 
206  // We are on the circle, ensure we are only on the arc, i.e. between
207  // m_ArcStart and m_ArcEnd
208 
209  wxPoint startEndVector = twoPointVector( m_ArcStart, m_ArcEnd);
210  wxPoint startRelativePositionVector = twoPointVector( m_ArcStart, relativePosition );
211 
212  wxPoint centerStartVector = twoPointVector( m_Pos, m_ArcStart );
213  wxPoint centerEndVector = twoPointVector( m_Pos, m_ArcEnd );
214  wxPoint centerRelativePositionVector = twoPointVector( m_Pos, relativePosition );
215 
216  // Compute the cross product to check if the point is in the sector
217  double crossProductStart = CrossProduct( centerStartVector, centerRelativePositionVector );
218  double crossProductEnd = CrossProduct( centerEndVector, centerRelativePositionVector );
219 
220  // The cross products need to be exchanged, depending on which side the center point
221  // relative to the start point to end point vector lies
222  if( CrossProduct( startEndVector, startRelativePositionVector ) < 0 )
223  {
224  std::swap( crossProductStart, crossProductEnd );
225  }
226 
227  // When the cross products have a different sign, the point lies in sector
228  // also check, if the reference is near start or end point
229  return HitTestPoints( m_ArcStart, relativePosition, MINIMUM_SELECTION_DISTANCE ) ||
230  HitTestPoints( m_ArcEnd, relativePosition, MINIMUM_SELECTION_DISTANCE ) ||
231  ( crossProductStart <= 0 && crossProductEnd >= 0 );
232 }
int m_Radius
Definition: lib_arc.h:47
static wxPoint twoPointVector(const wxPoint &startPoint, const wxPoint &endPoint)
Definition: lib_arc.cpp:46
double GetLineLength(const wxPoint &aPointA, const wxPoint &aPointB)
Function GetLineLength returns the length of a line segment defined by aPointA and aPointB...
Definition: trigo.h:191
static int KiROUND(double v)
KiROUND rounds a floating point number to an int using "round halfway cases away from zero"...
Definition: common.h:107
#define MINIMUM_SELECTION_DISTANCE
Definition: lib_draw_item.h:52
wxPoint m_ArcEnd
Definition: lib_arc.h:51
#define abs(a)
Definition: auxiliary.h:84
wxPoint m_Pos
Definition: lib_arc.h:52
double CrossProduct(const wxPoint &vectorA, const wxPoint &vectorB)
Determine the cross product.
Definition: trigo.h:166
int GetPenSize() const override
Function GetPenSize.
Definition: lib_arc.cpp:386
bool HitTestPoints(const wxPoint &pointA, const wxPoint &pointB, double threshold)
Test, if two points are near each other.
Definition: trigo.h:150
wxPoint m_ArcStart
Definition: lib_arc.h:50
bool LIB_ITEM::InEditMode ( ) const
inlineinherited

Return the draw item editing mode status.

Returns
True if the item is being edited.

Definition at line 395 of file lib_draw_item.h.

References IS_DRAGGED, IS_MOVED, IS_NEW, IS_RESIZED, and EDA_ITEM::m_Flags.

Referenced by LIB_ITEM::Draw(), LIB_EDIT_FRAME::EditField(), LIB_EDIT_FRAME::EditGraphicSymbol(), LIB_EDIT_FRAME::EditSymbolText(), LIB_EDIT_FRAME::IsEditingDrawItem(), LIB_EDIT_FRAME::OnEditPin(), LIB_EDIT_FRAME::OnHotKey(), LIB_EDIT_FRAME::OnLeftClick(), LIB_EDIT_FRAME::OnLeftDClick(), LIB_EDIT_FRAME::OnRightClick(), LIB_EDIT_FRAME::OnRotateItem(), LIB_TEXT::Rotate(), LIB_FIELD::Rotate(), LIB_TEXT::SetText(), and LIB_FIELD::SetText().

395 { return ( m_Flags & ( IS_NEW | IS_DRAGGED | IS_MOVED | IS_RESIZED ) ) != 0; }
#define IS_NEW
New item, just created.
Definition: base_struct.h:127
#define IS_DRAGGED
Item being dragged.
Definition: base_struct.h:129
STATUS_FLAGS m_Flags
Flag bits for editing and other uses.
Definition: base_struct.h:189
#define IS_RESIZED
Item being resized.
Definition: base_struct.h:128
#define IS_MOVED
Item being moved.
Definition: base_struct.h:126
bool LIB_ARC::Inside ( EDA_RECT aRect) const
overridevirtual

Function Inside tests if any part of the draw object is inside rectangle bounds of aRect.

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

Implements LIB_ITEM.

Definition at line 271 of file lib_arc.cpp.

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

272 {
273  return aRect.Contains( m_ArcStart.x, -m_ArcStart.y )
274  || aRect.Contains( m_ArcEnd.x, -m_ArcEnd.y );
275 }
bool Contains(const wxPoint &aPoint) const
Function Contains.
wxPoint m_ArcEnd
Definition: lib_arc.h:51
wxPoint m_ArcStart
Definition: lib_arc.h:50
bool EDA_ITEM::IsBrightened ( ) const
inlineinherited

Definition at line 238 of file base_struct.h.

References BRIGHTENED.

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

238 { return m_Flags & BRIGHTENED; }
#define BRIGHTENED
item is drawn with a bright contour
Definition: base_struct.h:151
STATUS_FLAGS m_Flags
Flag bits for editing and other uses.
Definition: base_struct.h:189
bool EDA_ITEM::IsDragging ( ) const
inlineinherited
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.

Returns
True if draw object can be filled. Default is false.

Definition at line 388 of file lib_draw_item.h.

References LIB_ITEM::m_isFillable.

Referenced by LIB_EDIT_FRAME::EditGraphicSymbol().

388 { return m_isFillable; }
bool m_isFillable
Flag to indicate if draw item is fillable.
bool EDA_ITEM::IsHighlighted ( ) const
inlineinherited

Definition at line 237 of file base_struct.h.

References HIGHLIGHTED.

237 { return m_Flags & HIGHLIGHTED; }
#define HIGHLIGHTED
item is drawn in normal colors, when the rest is darkened
Definition: base_struct.h:150
STATUS_FLAGS m_Flags
Flag bits for editing and other uses.
Definition: base_struct.h:189
bool EDA_ITEM::IsModified ( ) const
inlineinherited

Definition at line 231 of file base_struct.h.

References IS_CHANGED.

Referenced by LIB_EDIT_FRAME::OnEditPin().

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

Definition at line 230 of file base_struct.h.

References IS_NEW.

Referenced by Abort_Edit_Pcb_Text(), Abort_EditEdge(), Abort_Move_ModuleOutline(), Abort_MoveOrCopyModule(), Abort_Zone_Create_Outline(), AbortBuildDimension(), AbortMoveAndEditTarget(), abortMoveBitmap(), abortMoveItem(), AbortPinMove(), AbortSymbolTraceOn(), SCH_EDIT_FRAME::addCurrentItemToList(), SCH_EDIT_FRAME::addJunctionMenuEntries(), AddMenusForBus(), AddMenusForWire(), PCB_EDIT_FRAME::Delete_Segment(), PCB_EDIT_FRAME::Delete_Segment_Edge(), SCH_EDIT_FRAME::DeleteCurrentSegment(), drawEditGraphics(), drawGraphic(), DrawMovePin(), SCH_EDIT_FRAME::EditSheetPin(), LIB_PIN::EnableEditMode(), LIB_EDIT_FRAME::EndDrawGraphicItem(), SCH_EDIT_FRAME::EndSegment(), ExitSheet(), LIB_PART::LIB_PART(), SCH_EDIT_FRAME::OnAutoplaceFields(), SCH_EDIT_FRAME::OnConvertTextType(), LIB_EDIT_FRAME::OnEditPin(), SCH_EDIT_FRAME::OnHotKey(), FOOTPRINT_EDIT_FRAME::OnLeftClick(), LIB_EDIT_FRAME::OnLeftClick(), PCB_EDIT_FRAME::OnLeftClick(), FOOTPRINT_EDIT_FRAME::OnLeftDClick(), LIB_EDIT_FRAME::OnLeftDClick(), SCH_EDIT_FRAME::OnLeftDClick(), PCB_EDIT_FRAME::OnLeftDClick(), LIB_EDIT_FRAME::OnRightClick(), SCH_EDIT_FRAME::OnRightClick(), SCH_EDIT_FRAME::OnRotate(), PCB_EDIT_FRAME::Place_Texte_Pcb(), PCB_BASE_FRAME::PlaceModule(), LIB_EDIT_FRAME::PlacePin(), PCB_EDIT_FRAME::PlaceTarget(), SCH_EDIT_FRAME::PrepareMoveItem(), SCH_EDIT_FRAME::ReSizeSheet(), ShowClearance(), PCB_EDIT_FRAME::StartMoveTextePcb(), PCB_EDIT_FRAME::SwitchLayer(), and DIALOG_LABEL_EDITOR::TextPropertiesAccept().

230 { return m_Flags & IS_NEW; }
#define IS_NEW
New item, just created.
Definition: base_struct.h:127
STATUS_FLAGS m_Flags
Flag bits for editing and other uses.
Definition: base_struct.h:189
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_SHEET_PIN, SCH_FIELD, and SCH_TEXT.

Definition at line 458 of file base_struct.h.

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

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

Definition at line 236 of file base_struct.h.

References IS_RESIZED.

Referenced by ExitSheet().

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

Definition at line 234 of file base_struct.h.

References IS_WIRE_IMAGE.

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

234 { return m_Flags & IS_WIRE_IMAGE; }
#define IS_WIRE_IMAGE
Item to be drawn as wireframe while editing.
Definition: base_struct.h:131
STATUS_FLAGS m_Flags
Flag bits for editing and other uses.
Definition: base_struct.h:189
SEARCH_RESULT EDA_ITEM::IterateForward ( EDA_ITEM listStart,
INSPECTOR  inspector,
void *  testData,
const KICAD_T  scanTypes[] 
)
staticinherited

Function IterateForward walks through the object tree calling the inspector() on each object type requested in scanTypes.

Parameters
listStartThe first in a list of EDA_ITEMs to iterate over.
inspectorIs an INSPECTOR to call on each object that is one of the requested scanTypes.
testDataIs an aid to testFunc, and should be sufficient to allow it to fully determine if an item meets the match criteria, but it may also be used to collect output.
scanTypesA KICAD_T array that is EOT terminated, and provides both the order and interest level of of the types of objects to be iterated over.
Returns
SEARCH_RESULT SEARCH_QUIT if the called INSPECTOR returned SEARCH_QUIT, else SCAN_CONTINUE;

Definition at line 132 of file base_struct.cpp.

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

Referenced by SCH_COLLECTOR::Collect(), SCH_FIND_COLLECTOR::Collect(), SCH_TYPE_COLLECTOR::Collect(), GERBER_FILE_IMAGE::Visit(), MODULE::Visit(), and BOARD::Visit().

136 {
137  EDA_ITEM* p = listStart;
138 
139  for( ; p; p = p->Pnext )
140  {
141  if( SEARCH_QUIT == p->Visit( inspector, testData, scanTypes ) )
142  return SEARCH_QUIT;
143  }
144 
145  return SEARCH_CONTINUE;
146 }
virtual SEARCH_RESULT Visit(INSPECTOR inspector, void *testData, const KICAD_T scanTypes[])
Function Visit may be re-implemented for each derived class in order to handle all the types given by...
Class EDA_ITEM is a base class for most all the KiCad significant classes, used in schematics and boa...
Definition: base_struct.h:165
EDA_ITEM * Pnext
next in linked list
Definition: base_struct.h:178
bool LIB_ARC::Load ( LINE_READER aLineReader,
wxString &  aErrorMsg 
)
overridevirtual

Implements LIB_ITEM.

Definition at line 126 of file lib_arc.cpp.

References FILLED_SHAPE, FILLED_WITH_BG_BODYCOLOR, m_ArcEnd, m_ArcStart, LIB_ITEM::m_Convert, LIB_ITEM::m_Fill, m_Pos, m_Radius, m_t1, m_t2, LIB_ITEM::m_Unit, m_Width, NORMALIZE_ANGLE_POS(), RotatePoint(), wxPoint::x, and wxPoint::y.

127 {
128  int startx, starty, endx, endy, cnt;
129  char tmp[256] = "";
130  char* line = (char*) aLineReader;
131 
132  cnt = sscanf( line + 2, "%d %d %d %d %d %d %d %d %255s %d %d %d %d",
133  &m_Pos.x, &m_Pos.y, &m_Radius, &m_t1, &m_t2, &m_Unit,
134  &m_Convert, &m_Width, tmp, &startx, &starty, &endx, &endy );
135  if( cnt < 8 )
136  {
137  aErrorMsg.Printf( _( "Arc only had %d parameters of the required 8" ), cnt );
138  return false;
139  }
140 
141  if( tmp[0] == 'F' )
143 
144  if( tmp[0] == 'f' )
146 
149 
150  // Actual Coordinates of arc ends are read from file
151  if( cnt >= 13 )
152  {
153  m_ArcStart.x = startx;
154  m_ArcStart.y = starty;
155  m_ArcEnd.x = endx;
156  m_ArcEnd.y = endy;
157  }
158  else
159  {
160  // Actual Coordinates of arc ends are not read from file
161  // (old library), calculate them
163  m_ArcStart.y = 0;
164  m_ArcEnd.x = m_Radius;
165  m_ArcEnd.y = 0;
167  m_ArcStart.x += m_Pos.x;
168  m_ArcStart.y += m_Pos.y;
170  m_ArcEnd.x += m_Pos.x;
171  m_ArcEnd.y += m_Pos.y;
172  }
173 
174  return true;
175 }
int m_Radius
Definition: lib_arc.h:47
int m_t1
Definition: lib_arc.h:48
int m_t2
Definition: lib_arc.h:49
int m_Unit
Unit identification for multiple parts per package.
void RotatePoint(int *pX, int *pY, double angle)
Definition: trigo.cpp:317
wxPoint m_ArcEnd
Definition: lib_arc.h:51
void NORMALIZE_ANGLE_POS(T &Angle)
Definition: trigo.h:230
wxPoint m_Pos
Definition: lib_arc.h:52
FILL_T m_Fill
The body fill type.
int m_Convert
Shape identification for alternate body styles.
wxPoint m_ArcStart
Definition: lib_arc.h:50
int m_Width
Definition: lib_arc.h:53
virtual bool EDA_ITEM::Matches ( wxFindReplaceData &  aSearchData,
void *  aAuxData,
wxPoint aFindLocation 
)
inlinevirtualinherited

Function Matches compares the item against the search criteria in aSearchData.

The base class returns false since many of the objects derived from EDA_ITEM do not have any text to search.

Parameters
aSearchDataA reference to a wxFindReplaceData object containing the search criteria.
aAuxDataA pointer to optional data required for the search or NULL if not used.
aFindLocationA pointer to a wxPoint object to store the location of matched item. The pointer can be NULL if it is not used.
Returns
True if the item's text matches the search criteria in aSearchData.

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

Definition at line 414 of file base_struct.h.

Referenced by SCH_FIND_COLLECTOR::Inspect(), SCH_MARKER::Matches(), LIB_PIN::Matches(), SCH_TEXT::Matches(), SCH_FIELD::Matches(), SCH_SHEET_PIN::Matches(), and SCH_SHEET::Matches().

415  {
416  return false;
417  }
bool EDA_ITEM::Matches ( const wxString &  aText,
wxFindReplaceData &  aSearchData 
)
protectedinherited

Function Matches compares aText against search criteria in aSearchData.

This is a helper function for simplify derived class logic.

Parameters
aTextA reference to a wxString object containing the string to test.
aSearchDataThe criteria to search against.
Returns
True if aText matches the search criteria in aSearchData.

Definition at line 184 of file base_struct.cpp.

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

185 {
186  wxString text = aText;
187  wxString searchText = aSearchData.GetFindString();
188 
189  // Don't match if searching for replaceable item and the item doesn't support text replace.
190  if( (aSearchData.GetFlags() & FR_SEARCH_REPLACE) && !IsReplaceable() )
191  return false;
192 
193  if( aSearchData.GetFlags() & wxFR_WHOLEWORD )
194  return aText.IsSameAs( searchText, aSearchData.GetFlags() & wxFR_MATCHCASE );
195 
196  if( aSearchData.GetFlags() & FR_MATCH_WILDCARD )
197  {
198  if( aSearchData.GetFlags() & wxFR_MATCHCASE )
199  return text.Matches( searchText );
200 
201  return text.MakeUpper().Matches( searchText.MakeUpper() );
202  }
203 
204  if( aSearchData.GetFlags() & wxFR_MATCHCASE )
205  return aText.Find( searchText ) != wxNOT_FOUND;
206 
207  return text.MakeUpper().Find( searchText.MakeUpper() ) != wxNOT_FOUND;
208 }
virtual bool IsReplaceable() const
Function IsReplaceable.
Definition: base_struct.h:458
Perform search using simple wild card matching (* & ?).
Perform a search for a item that has replaceable text.
void LIB_ARC::MirrorHorizontal ( const wxPoint aCenter)
overridevirtual

Function MirrorHorizontal mirrors the draw object along the horizontal (X) axis about aCenter point.

Parameters
aCenterPoint to mirror around.

Implements LIB_ITEM.

Definition at line 287 of file lib_arc.cpp.

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

288 {
289  m_Pos.x -= aCenter.x;
290  m_Pos.x *= -1;
291  m_Pos.x += aCenter.x;
292  m_ArcStart.x -= aCenter.x;
293  m_ArcStart.x *= -1;
294  m_ArcStart.x += aCenter.x;
295  m_ArcEnd.x -= aCenter.x;
296  m_ArcEnd.x *= -1;
297  m_ArcEnd.x += aCenter.x;
298  std::swap( m_ArcStart, m_ArcEnd );
299  std::swap( m_t1, m_t2 );
300  m_t1 = 1800 - m_t1;
301  m_t2 = 1800 - m_t2;
302  if( m_t1 > 3600 || m_t2 > 3600 )
303  {
304  m_t1 -= 3600;
305  m_t2 -= 3600;
306  }
307  else if( m_t1 < -3600 || m_t2 < -3600 )
308  {
309  m_t1 += 3600;
310  m_t2 += 3600;
311  }
312 }
int m_t1
Definition: lib_arc.h:48
int m_t2
Definition: lib_arc.h:49
wxPoint m_ArcEnd
Definition: lib_arc.h:51
wxPoint m_Pos
Definition: lib_arc.h:52
wxPoint m_ArcStart
Definition: lib_arc.h:50
void LIB_ARC::MirrorVertical ( const wxPoint aCenter)
overridevirtual

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

Parameters
aCenterPoint to mirror around.

Implements LIB_ITEM.

Definition at line 314 of file lib_arc.cpp.

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

315 {
316  m_Pos.y -= aCenter.y;
317  m_Pos.y *= -1;
318  m_Pos.y += aCenter.y;
319  m_ArcStart.y -= aCenter.y;
320  m_ArcStart.y *= -1;
321  m_ArcStart.y += aCenter.y;
322  m_ArcEnd.y -= aCenter.y;
323  m_ArcEnd.y *= -1;
324  m_ArcEnd.y += aCenter.y;
325  std::swap( m_ArcStart, m_ArcEnd );
326  std::swap( m_t1, m_t2 );
327  m_t1 = - m_t1;
328  m_t2 = - m_t2;
329  if( m_t1 > 3600 || m_t2 > 3600 )
330  {
331  m_t1 -= 3600;
332  m_t2 -= 3600;
333  }
334  else if( m_t1 < -3600 || m_t2 < -3600 )
335  {
336  m_t1 += 3600;
337  m_t2 += 3600;
338  }
339 }
int m_t1
Definition: lib_arc.h:48
int m_t2
Definition: lib_arc.h:49
wxPoint m_ArcEnd
Definition: lib_arc.h:51
wxPoint m_Pos
Definition: lib_arc.h:52
wxPoint m_ArcStart
Definition: lib_arc.h:50
void LIB_ARC::Move ( const wxPoint aPosition)
overridevirtual

Function Move moves a draw object to aPosition.

Parameters
aPositionPosition to move draw item to.

Implements LIB_ITEM.

Definition at line 278 of file lib_arc.cpp.

References m_ArcEnd, m_ArcStart, and m_Pos.

Referenced by calcEdit().

279 {
280  wxPoint offset = aPosition - m_Pos;
281  m_Pos = aPosition;
282  m_ArcStart += offset;
283  m_ArcEnd += offset;
284 }
wxPoint m_ArcEnd
Definition: lib_arc.h:51
wxPoint m_Pos
Definition: lib_arc.h:52
wxPoint m_ArcStart
Definition: lib_arc.h:50
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 96 of file lib_draw_item.cpp.

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

97 {
98  int result = m_Convert - aOther.m_Convert;
99 
100  if( result != 0 )
101  return result < 0;
102 
103  result = m_Unit - aOther.m_Unit;
104 
105  if( result != 0 )
106  return result < 0;
107 
108  result = Type() - aOther.Type();
109 
110  if( result != 0 )
111  return result < 0;
112 
113  return ( compare( aOther ) < 0 );
114 }
KICAD_T Type() const
Function Type()
Definition: base_struct.h:212
int m_Unit
Unit identification for multiple parts per package.
virtual int compare(const LIB_ITEM &aOther) const =0
Function compare provides the draw object specific comparison called by the == and < operators...
int m_Convert
Shape identification for alternate body styles.
bool EDA_ITEM::operator< ( const EDA_ITEM aItem) const
inherited

Test if another item is less than this object.

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

Definition at line 241 of file base_struct.cpp.

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

242 {
243  wxFAIL_MSG( wxString::Format( wxT( "Less than operator not defined for item type %s." ),
244  GetChars( GetClass() ) ) );
245 
246  return false;
247 }
static const wxChar * GetChars(const wxString &s)
Function GetChars returns a wxChar* to the actual wxChar* data within a wxString, and is helpful for ...
Definition: macros.h:92
virtual wxString GetClass() const =0
Function GetClass returns the class name.
void Format(OUTPUTFORMATTER *out, int aNestLevel, int aCtl, CPTREE &aTree)
Function Format outputs a PTREE into s-expression format via an OUTPUTFORMATTER derivative.
Definition: ptree.cpp:205
bool 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 87 of file lib_draw_item.cpp.

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

88 {
89  return ( ( Type() == aOther.Type() )
90  && ( m_Unit == aOther.m_Unit )
91  && ( m_Convert == aOther.m_Convert )
92  && compare( aOther ) == 0 );
93 }
KICAD_T Type() const
Function Type()
Definition: base_struct.h:212
int m_Unit
Unit identification for multiple parts per package.
virtual int compare(const LIB_ITEM &aOther) const =0
Function compare provides the draw object specific comparison called by the == and < operators...
int m_Convert
Shape identification for alternate body styles.
bool LIB_ITEM::operator== ( const LIB_ITEM aOther) const
inlineinherited

Definition at line 277 of file lib_draw_item.h.

278  {
279  return *this == *aOther;
280  }
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 363 of file lib_arc.cpp.

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

365 {
366  wxASSERT( aPlotter != NULL );
367 
368  int t1 = m_t1;
369  int t2 = m_t2;
370  wxPoint pos = aTransform.TransformCoordinate( m_Pos ) + aOffset;
371 
372  aTransform.MapAngles( &t1, &t2 );
373 
374  if( aFill && m_Fill == FILLED_WITH_BG_BODYCOLOR )
375  {
377  aPlotter->Arc( pos, -t2, -t1, m_Radius, FILLED_SHAPE, 0 );
378  }
379 
380  bool already_filled = m_Fill == FILLED_WITH_BG_BODYCOLOR;
381  aPlotter->SetColor( GetLayerColor( LAYER_DEVICE ) );
382  aPlotter->Arc( pos, -t2, -t1, m_Radius, already_filled ? NO_FILL : m_Fill, GetPenSize() );
383 }
int m_Radius
Definition: lib_arc.h:47
int m_t1
Definition: lib_arc.h:48
virtual void SetColor(COLOR4D color)=0
int m_t2
Definition: lib_arc.h:49
COLOR4D GetLayerColor(SCH_LAYER_ID aLayer)
Definition: eeschema.cpp:167
wxPoint TransformCoordinate(const wxPoint &aPoint) const
Calculate a new coordinate according to the mirror/rotation transform.
Definition: transform.cpp:41
bool MapAngles(int *aAngle1, int *aAngle2) const
Calculate new angles according to the transform.
Definition: transform.cpp:80
wxPoint m_Pos
Definition: lib_arc.h:52
int GetPenSize() const override
Function GetPenSize.
Definition: lib_arc.cpp:386
FILL_T m_Fill
The body fill type.
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.
bool EDA_ITEM::Replace ( wxFindReplaceData &  aSearchData,
wxString &  aText 
)
inherited

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

Parameters
aSearchDataA reference to a wxFindReplaceData object containing the search and replace criteria.
aTextA reference to a wxString object containing the text to be replaced.
Returns
True if aText was modified, otherwise false.

Definition at line 211 of file base_struct.cpp.

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

Referenced by SCH_TEXT::Replace(), SCH_FIELD::Replace(), SCH_SHEET_PIN::Replace(), SCH_SHEET::Replace(), and SCH_FIND_COLLECTOR::ReplaceItem().

212 {
213  wxCHECK_MSG( IsReplaceable(), false,
214  wxT( "Attempt to replace text in <" ) + GetClass() + wxT( "> item." ) );
215 
216  wxString searchString = (aSearchData.GetFlags() & wxFR_MATCHCASE) ? aText : aText.Upper();
217 
218  int result = searchString.Find( (aSearchData.GetFlags() & wxFR_MATCHCASE) ?
219  aSearchData.GetFindString() :
220  aSearchData.GetFindString().Upper() );
221 
222  if( result == wxNOT_FOUND )
223  return false;
224 
225  wxString prefix = aText.Left( result );
226  wxString suffix;
227 
228  if( aSearchData.GetFindString().length() + result < aText.length() )
229  suffix = aText.Right( aText.length() - ( aSearchData.GetFindString().length() + result ) );
230 
231  wxLogTrace( traceFindReplace, wxT( "Replacing '%s', prefix '%s', replace '%s', suffix '%s'." ),
232  GetChars( aText ), GetChars( prefix ), GetChars( aSearchData.GetReplaceString() ),
233  GetChars( suffix ) );
234 
235  aText = prefix + aSearchData.GetReplaceString() + suffix;
236 
237  return true;
238 }
virtual bool IsReplaceable() const
Function IsReplaceable.
Definition: base_struct.h:458
const wxString traceFindReplace
Flag to enable find and replace debug tracing.
Definition: base_struct.cpp:58
static const wxChar * GetChars(const wxString &s)
Function GetChars returns a wxChar* to the actual wxChar* data within a wxString, and is helpful for ...
Definition: macros.h:92
virtual wxString GetClass() const =0
Function GetClass returns the class name.
virtual bool EDA_ITEM::Replace ( wxFindReplaceData &  aSearchData,
void *  aAuxData = NULL 
)
inlinevirtualinherited

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

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

Parameters
aSearchDataA reference to a wxFindReplaceData object containing the search and replace criteria.
aAuxDataA pointer to optional data required for the search or NULL if not used.
Returns
True if the item text was modified, otherwise false.

Reimplemented in SCH_SHEET, SCH_SHEET_PIN, SCH_FIELD, and SCH_TEXT.

Definition at line 446 of file base_struct.h.

446 { return false; }
void LIB_ARC::Rotate ( const wxPoint aCenter,
bool  aRotateCCW = true 
)
overridevirtual

Function Rotate rotates 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 341 of file lib_arc.cpp.

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

342 {
343  int rot_angle = aRotateCCW ? -900 : 900;
344  RotatePoint( &m_Pos, aCenter, rot_angle );
345  RotatePoint( &m_ArcStart, aCenter, rot_angle );
346  RotatePoint( &m_ArcEnd, aCenter, rot_angle );
347  m_t1 -= rot_angle;
348  m_t2 -= rot_angle;
349  if( m_t1 > 3600 || m_t2 > 3600 )
350  {
351  m_t1 -= 3600;
352  m_t2 -= 3600;
353  }
354  else if( m_t1 < -3600 || m_t2 < -3600 )
355  {
356  m_t1 += 3600;
357  m_t2 += 3600;
358  }
359 }
int m_t1
Definition: lib_arc.h:48
int m_t2
Definition: lib_arc.h:49
void RotatePoint(int *pX, int *pY, double angle)
Definition: trigo.cpp:317
wxPoint m_ArcEnd
Definition: lib_arc.h:51
wxPoint m_Pos
Definition: lib_arc.h:52
wxPoint m_ArcStart
Definition: lib_arc.h:50
virtual void LIB_ITEM::Rotate ( )
inlinevirtualinherited

Rotate the draw item.

Reimplemented in LIB_PIN, LIB_FIELD, and LIB_TEXT.

Definition at line 353 of file lib_draw_item.h.

353 {}
bool LIB_ARC::Save ( OUTPUTFORMATTER aFormatter)
overridevirtual

Function Save writes draw item object to aFormatter in component library "*.lib" format.

Parameters
aFormatterA reference to an OUTPUTFORMATTER object to write the component library item to.
Returns
True if success writing else false.

Implements LIB_ITEM.

Definition at line 105 of file lib_arc.cpp.

References fill_tab, m_ArcEnd, m_ArcStart, LIB_ITEM::m_Convert, LIB_ITEM::m_Fill, m_Pos, m_Radius, m_t1, m_t2, LIB_ITEM::m_Unit, m_Width, OUTPUTFORMATTER::Print(), wxPoint::x, and wxPoint::y.

106 {
107  int x1 = m_t1;
108 
109  if( x1 > 1800 )
110  x1 -= 3600;
111 
112  int x2 = m_t2;
113 
114  if( x2 > 1800 )
115  x2 -= 3600;
116 
117  aFormatter.Print( 0, "A %d %d %d %d %d %d %d %d %c %d %d %d %d\n",
118  m_Pos.x, m_Pos.y, m_Radius, x1, x2, m_Unit, m_Convert, m_Width,
120  m_ArcEnd.y );
121 
122  return true;
123 }
int m_Radius
Definition: lib_arc.h:47
int m_t1
Definition: lib_arc.h:48
int m_t2
Definition: lib_arc.h:49
int m_Unit
Unit identification for multiple parts per package.
wxPoint m_ArcEnd
Definition: lib_arc.h:51
wxPoint m_Pos
Definition: lib_arc.h:52
const int fill_tab[3]
FILL_T m_Fill
The body fill type.
int m_Convert
Shape identification for alternate body styles.
int PRINTF_FUNC Print(int nestLevel, const char *fmt,...)
Function Print formats and writes text to the output stream.
Definition: richio.cpp:408
wxPoint m_ArcStart
Definition: lib_arc.h:50
int m_Width
Definition: lib_arc.h:53
void EDA_ITEM::SetBack ( EDA_ITEM aBack)
inlineinherited

Definition at line 226 of file base_struct.h.

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

226 { Pback = aBack; }
EDA_ITEM * Pback
previous in linked list
Definition: base_struct.h:179
void EDA_ITEM::SetBrightened ( )
inlineinherited

Definition at line 243 of file base_struct.h.

References BRIGHTENED, and EDA_ITEM::SetFlags().

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

243 { SetFlags( BRIGHTENED ); }
void SetFlags(STATUS_FLAGS aMask)
Definition: base_struct.h:267
#define BRIGHTENED
item is drawn with a bright contour
Definition: base_struct.h:151
void LIB_ITEM::SetConvert ( int  aConvert)
inlineinherited

Definition at line 405 of file lib_draw_item.h.

Referenced by LIB_EDIT_FRAME::CreateGraphicItem(), LIB_EDIT_FRAME::CreateImagePins(), LIB_EDIT_FRAME::CreatePin(), LIB_EDIT_FRAME::EditGraphicSymbol(), and DIALOG_LIB_EDIT_TEXT::OnOkClick().

405 { m_Convert = aConvert; }
int m_Convert
Shape identification for alternate body styles.
void LIB_ARC::SetEnd ( const wxPoint aPoint)
inline

Definition at line 150 of file lib_arc.h.

150 { m_ArcEnd = aPoint; }
wxPoint m_ArcEnd
Definition: lib_arc.h:51
void LIB_ITEM::SetFillMode ( FILL_T  aFillMode)
inlineinherited

Definition at line 409 of file lib_draw_item.h.

Referenced by LIB_EDIT_FRAME::CreateGraphicItem(), and LIB_EDIT_FRAME::EditGraphicSymbol().

409 { m_Fill = aFillMode; }
FILL_T m_Fill
The body fill type.
void LIB_ARC::SetFirstRadiusAngle ( int  aAngle)
inline

Definition at line 140 of file lib_arc.h.

140 { m_t1 = aAngle; }
int m_t1
Definition: lib_arc.h:48
void EDA_ITEM::SetFlags ( STATUS_FLAGS  aMask)
inlineinherited

Definition at line 267 of file base_struct.h.

Referenced by SCH_EAGLE_PLUGIN::addBusEntries(), SCH_SCREEN::addConnectedItemsToBlock(), AddSegmentToDragList(), PCB_EDIT_FRAME::AppendBoardFile(), PCB_EDIT_FRAME::Begin_DrawSegment(), FOOTPRINT_EDIT_FRAME::Begin_Edge_Module(), PCB_EDIT_FRAME::Begin_Route(), PCB_EDIT_FRAME::Begin_Zone(), PCB_EDIT_FRAME::BeginMoveDimensionText(), PCB_EDIT_FRAME::BeginMoveTarget(), SCH_EDIT_FRAME::BeginSegment(), PCB_EDIT_FRAME::Change_Side_Module(), SCH_EDIT_FRAME::ConvertPart(), CopyMarkedItems(), DIALOG_EDIT_COMPONENT_IN_SCHEMATIC::copyPanelToOptions(), LIB_PART::CopySelectedItems(), SCH_EDIT_FRAME::CreateBusBusEntry(), SCH_EDIT_FRAME::CreateBusWireEntry(), SCH_EDIT_FRAME::CreateNewImage(), SCH_EDIT_FRAME::CreateNewText(), LIB_EDIT_FRAME::CreatePin(), SCH_EDIT_FRAME::CreateSheet(), SCH_EDIT_FRAME::CreateSheetPin(), PCB_EDIT_FRAME::CreateTarget(), PCB_EDIT_FRAME::CreateTextePcb(), FOOTPRINT_EDIT_FRAME::CreateTextModule(), PCB_EDIT_FRAME::EditDimension(), LIB_PIN::EnableEditMode(), PCB_EDIT_FRAME::FlipTextePcb(), SCH_SCREEN::GetConnection(), PCB_BASE_FRAME::GlobalChange_PadSettings(), FOOTPRINT_EDIT_FRAME::HandleBlockEnd(), PCB_BASE_FRAME::Import_Pad_Settings(), SCH_EDIT_FRAME::ImportSheetPin(), SCH_JUNCTION::IsSelectStateChanged(), SCH_NO_CONNECT::IsSelectStateChanged(), SCH_MARKER::IsSelectStateChanged(), SCH_BUS_ENTRY_BASE::IsSelectStateChanged(), SCH_LINE::IsSelectStateChanged(), SCH_BITMAP::IsSelectStateChanged(), SCH_TEXT::IsSelectStateChanged(), SCH_SHEET::IsSelectStateChanged(), SCH_COMPONENT::IsSelectStateChanged(), SCH_EDIT_FRAME::Load_Component(), PCB_BASE_FRAME::LoadModuleFromLibrary(), SCH_SCREEN::MarkConnections(), MarkItemsInBloc(), moveBitmap(), SCH_EDIT_FRAME::MoveImage(), SCH_EDIT_FRAME::OnConvertTextType(), SCH_EDIT_FRAME::OnCopySchematicItemRequest(), LIB_EDIT_FRAME::OnEditPin(), TARGET_PROPERTIES_DIALOG_EDITOR::OnOkClick(), SCH_EDIT_FRAME::OnSelectUnit(), PCB_EDIT_FRAME::Other_Layer_Route(), DRAWING_TOOL::PlaceText(), SCH_EDIT_FRAME::PrepareMoveItem(), LIB_EDIT_FRAME::Process_Special_Functions(), EDIT_TOOL::Properties(), SCH_EDIT_FRAME::PutDataInPreviousState(), SCH_EDIT_FRAME::RepeatDrawItem(), LIB_EDIT_FRAME::RepeatPinItem(), SCH_EDIT_FRAME::ReSizeSheet(), PCB_BASE_FRAME::Rotate_Module(), PCB_EDIT_FRAME::Rotate_Texte_Pcb(), SCH_SCREEN::SchematicCleanUp(), SCH_SCREEN::SelectBlockItems(), EDA_ITEM::SetBrightened(), LIB_PIN::SetConversion(), EDA_ITEM::SetHighlighted(), EDA_ITEM::SetModified(), EDA_ITEM::SetSelected(), EDA_ITEM::SetWireImage(), PCB_EDIT_FRAME::Start_DragTrackSegmentAndKeepSlope(), PCB_EDIT_FRAME::Start_Move_DrawItem(), FOOTPRINT_EDIT_FRAME::Start_Move_EdgeMod(), PCB_EDIT_FRAME::Start_Move_Zone_Corner(), PCB_EDIT_FRAME::Start_Move_Zone_Drag_Outline_Edge(), PCB_EDIT_FRAME::Start_Move_Zone_Outlines(), PCB_EDIT_FRAME::StartMoveModule(), PCB_EDIT_FRAME::StartMoveOneNodeOrSegment(), PCB_BASE_FRAME::StartMovePad(), LIB_EDIT_FRAME::StartMovePin(), PCB_BASE_FRAME::StartMoveTexteModule(), PCB_EDIT_FRAME::StartMoveTextePcb(), DIALOG_PCB_TEXT_PROPERTIES::TransferDataFromWindow(), DIALOG_PAD_PROPERTIES::TransferDataFromWindow(), and UndrawAndMarkSegmentsToDrag().

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

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

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

Definition at line 242 of file base_struct.h.

References HIGHLIGHTED, and EDA_ITEM::SetFlags().

242 { SetFlags( HIGHLIGHTED ); }
void SetFlags(STATUS_FLAGS aMask)
Definition: base_struct.h:267
#define HIGHLIGHTED
item is drawn in normal colors, when the rest is darkened
Definition: base_struct.h:150
void EDA_ITEM::SetList ( DHEAD aList)
inlineinherited

Definition at line 228 of file base_struct.h.

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

228 { m_List = aList; }
DHEAD * m_List
which DLIST I am on.
Definition: base_struct.h:180
void EDA_ITEM::SetModified ( )
inherited
void EDA_ITEM::SetNext ( EDA_ITEM aNext)
inlineinherited

Definition at line 225 of file base_struct.h.

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

225 { Pnext = aNext; }
EDA_ITEM * Pnext
next in linked list
Definition: base_struct.h:178
void LIB_ARC::SetOffset ( const wxPoint aOffset)
overridevirtual

Function Offset sets the drawing object by aOffset from the current position.

Parameters
aOffsetCoordinates to offset the item position.

Implements LIB_ITEM.

Definition at line 263 of file lib_arc.cpp.

References m_ArcEnd, m_ArcStart, and m_Pos.

264 {
265  m_Pos += aOffset;
266  m_ArcStart += aOffset;
267  m_ArcEnd += aOffset;
268 }
wxPoint m_ArcEnd
Definition: lib_arc.h:51
wxPoint m_Pos
Definition: lib_arc.h:52
wxPoint m_ArcStart
Definition: lib_arc.h:50
void EDA_ITEM::SetParent ( EDA_ITEM aParent)
inlineinherited

Definition at line 227 of file base_struct.h.

Referenced by MODULE::Add(), BOARD::Add(), BOARD_NETLIST_UPDATER::addNewComponent(), LIB_FIELD::Copy(), SCH_EDIT_FRAME::copyBlockItems(), CopyMarkedItems(), SCH_EDIT_FRAME::CreateSheet(), DIALOG_LIB_EDIT_PIN::DIALOG_LIB_EDIT_PIN(), PCB_EDIT_FRAME::Exchange_Module(), PCB_IO::FootprintSave(), DISPLAY_FOOTPRINTS_FRAME::Get_Module(), DIALOG_MODULE_MODULE_EDITOR::initModeditProperties(), DIALOG_MODULE_BOARD_EDITOR::InitModeditProperties(), LIB_PART::LIB_PART(), SCH_SHEET::Load(), FOOTPRINT_EDIT_FRAME::Load_Module_From_BOARD(), SCH_LEGACY_PLUGIN::loadHierarchy(), LIB_EDIT_FRAME::LoadOneSymbol(), MODULE::MODULE(), DIALOG_MODULE_BOARD_EDITOR::OnEditReference(), DIALOG_MODULE_BOARD_EDITOR::OnEditValue(), DIALOG_LIB_EDIT_PIN::OnPaintShowPanel(), MODULE::operator=(), SCH_COMPONENT::operator=(), PCB_PARSER::parseMODULE_unchecked(), PCBNEW_CONTROL::PasteItemsFromClipboard(), FOOTPRINT_EDIT_FRAME::Process_Special_Functions(), BOARD_COMMIT::Push(), FOOTPRINT_PREVIEW_PANEL::renderFootprint(), BOARD_NETLIST_UPDATER::replaceComponent(), BOARD::ReplaceNetlist(), FOOTPRINT_EDIT_FRAME::restoreLastFootprint(), PCB_BASE_EDIT_FRAME::SaveCopyInUndoList(), SaveCopyOfZones(), SCH_COMPONENT::SCH_COMPONENT(), SCH_SHEET::SCH_SHEET(), SCH_SHEET_PIN::SCH_SHEET_PIN(), LIB_PART::SetFields(), SetSchItemParent(), PCB_EDIT_FRAME::StartMoveModule(), BOARD_ITEM::SwapData(), SCH_SHEET::SwapData(), and SCH_COMPONENT::SwapData().

227 { m_Parent = aParent; }
EDA_ITEM * m_Parent
Linked list: Link (parent struct)
Definition: base_struct.h:182
void LIB_ITEM::SetPosition ( const wxPoint aPosition)
inlineinherited

Definition at line 323 of file lib_draw_item.h.

References LIB_ITEM::Move().

323 { Move( aPosition ); }
virtual void Move(const wxPoint &aPosition)=0
Function Move moves a draw object to aPosition.
void LIB_ARC::SetRadius ( int  aRadius)
inline

Definition at line 136 of file lib_arc.h.

136 { m_Radius = aRadius; }
int m_Radius
Definition: lib_arc.h:47
void LIB_ARC::SetSecondRadiusAngle ( int  aAngle)
inline

Definition at line 144 of file lib_arc.h.

144 { m_t2 = aAngle; }
int m_t2
Definition: lib_arc.h:49
void EDA_ITEM::SetSelected ( )
inlineinherited

Definition at line 241 of file base_struct.h.

References SELECTED, and EDA_ITEM::SetFlags().

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

241 { SetFlags( SELECTED ); }
#define SELECTED
Definition: base_struct.h:134
void SetFlags(STATUS_FLAGS aMask)
Definition: base_struct.h:267
void LIB_ARC::SetStart ( const wxPoint aPoint)
inline

Definition at line 148 of file lib_arc.h.

148 { m_ArcStart = aPoint; }
wxPoint m_ArcStart
Definition: lib_arc.h:50
void EDA_ITEM::SetStatus ( STATUS_FLAGS  aStatus)
inlineinherited
void EDA_ITEM::SetTimeStamp ( time_t  aNewTimeStamp)
inlineinherited

Definition at line 217 of file base_struct.h.

Referenced by BOARD_NETLIST_UPDATER::addNewComponent(), PCAD2KICAD::PCB_TEXT::AddToBoard(), PCAD2KICAD::PCB_PAD::AddToBoard(), PCAD2KICAD::PCB_ARC::AddToBoard(), PCAD2KICAD::PCB_LINE::AddToBoard(), PCAD2KICAD::PCB_POLYGON::AddToBoard(), PCAD2KICAD::PCB_MODULE::AddToBoard(), SCH_EDIT_FRAME::AppendOneEEProject(), PCB_EDIT_FRAME::Begin_Zone(), SCH_EDIT_FRAME::CreateSheet(), Diagnose(), DuplicateItemsInList(), DuplicateStruct(), EDIT_TOOL::editFootprintInFpEditor(), PCB_EDIT_FRAME::Exchange_Module(), PCB_IO::FootprintSave(), DIALOG_MODULE_BOARD_EDITOR::GotoModuleEditor(), EDA_ITEM::initVars(), BOARD::InsertArea(), SCH_SHEET::Load(), LEGACY_PLUGIN::loadMODULE(), PCB_BASE_FRAME::LoadModuleFromLibrary(), LEGACY_PLUGIN::loadPCB_TARGET(), LEGACY_PLUGIN::loadPCB_TEXT(), EAGLE_PLUGIN::loadPlain(), EAGLE_PLUGIN::loadSignals(), LEGACY_PLUGIN::loadTrackList(), EDA_ITEM::operator=(), EAGLE_PLUGIN::packageCircle(), EAGLE_PLUGIN::packagePolygon(), EAGLE_PLUGIN::packageRectangle(), EAGLE_PLUGIN::packageText(), SCH_EDIT_FRAME::PasteListOfItems(), FOOTPRINT_EDIT_FRAME::Process_Special_Functions(), PCB_EDIT_FRAME::Process_Special_Functions(), SCH_SCREENS::ReplaceDuplicateTimeStamps(), BOARD::ReplaceNetlist(), SCH_SHEET::SCH_SHEET(), SCH_COMPONENT::SetTimeStamp(), SimilarLabelsDiagnose(), BOARD_ITEM::SwapData(), and TestDuplicateSheetNames().

217 { m_TimeStamp = aNewTimeStamp; }
time_t m_TimeStamp
Time stamp used for logical links.
Definition: base_struct.h:183
void LIB_ITEM::SetUnit ( int  aUnit)
inlineinherited
void LIB_ARC::SetWidth ( int  aWidth)
inlineoverridevirtual

Function SetWidth sets the width of the draw item to aWidth.

Implements LIB_ITEM.

Definition at line 134 of file lib_arc.h.

134 { m_Width = aWidth; }
int m_Width
Definition: lib_arc.h:53
void EDA_ITEM::SetWireImage ( )
inlineinherited

Definition at line 240 of file base_struct.h.

References IS_WIRE_IMAGE, and EDA_ITEM::SetFlags().

Referenced by moveItemWithMouseCursor().

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

Referenced by PART_LIB::GetEntryTypePowerNames().

477 { return *aLeft < *aRight; }
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 212 of file base_struct.h.

References EDA_ITEM::m_StructType.

Referenced by Abort_Move_ModuleOutline(), abortMoveBitmap(), abortMoveItem(), AbortPinMove(), MODULE::Add(), CN_CLUSTER::Add(), BOARD::Add(), CN_CONNECTIVITY_ALGO::Add(), PCB_EDIT_FRAME::Add45DegreeSegment(), SCH_SCREEN::addConnectedItemsToBlock(), POINT_EDITOR::addCorner(), POINT_EDITOR::addCornerCondition(), SCH_EDIT_FRAME::addCurrentItemToList(), AddMenusForComponent(), AddMenusForEditComponent(), SCH_SHEET::AddPin(), SCH_EDIT_FRAME::AppendOneEEProject(), PCB_EDIT_FRAME::Attribut_Track(), PCB_EDIT_FRAME::Autoroute(), PCB_EDIT_FRAME::Begin_Route(), SCH_EDIT_FRAME::BeginSegment(), PCB_EDIT_FRAME::Block_Delete(), PCB_EDIT_FRAME::Block_Duplicate(), PCB_EDIT_FRAME::Block_Flip(), PCB_EDIT_FRAME::Block_Move(), PCB_EDIT_FRAME::Block_Rotate(), SCH_SCREENS::BuildScreenList(), SCH_SHEET_LIST::BuildSheetList(), HIERARCHY_NAVIG_DLG::BuildTree(), calcArea(), calcMaxArea(), DIALOG_EXCHANGE_MODULE::changeAllFootprints(), DIALOG_EXCHANGE_MODULE::changeSameFootprints(), TEXTE_PCB::ClassOf(), EDGE_MODULE::ClassOf(), BOARD_CONNECTED_ITEM::ClassOf(), TEXTE_MODULE::ClassOf(), DRAWSEGMENT::ClassOf(), TRACK::ClassOf(), NETINFO_ITEM::ClassOf(), MODULE::ClassOf(), D_PAD::ClassOf(), BOARD::ClassOf(), VIA::ClassOf(), SCH_SHEET::CleanupSheet(), Collect_TrackSegmentsToDrag(), LIB_BEZIER::compare(), LIB_CIRCLE::compare(), LIB_RECTANGLE::compare(), LIB_POLYLINE::compare(), LIB_TEXT::compare(), compare(), LIB_FIELD::compare(), LIB_PIN::compare(), SCH_SHEET::ComponentCount(), GRID_HELPER::computeAnchors(), SCH_SCREEN::CountConnectedItems(), SCH_SHEET::CountSheets(), LIB_EDIT_FRAME::CreateGraphicItem(), CINFO3D_VISU::createLayers(), BOARD::CreateLockPoint(), SCH_EDIT_FRAME::CreateNewText(), CINFO3D_VISU::createNewTrack(), PCB_EDIT_FRAME::createPopupMenuForTracks(), CreateRoutesSection(), PCB_EDITOR_CONTROL::CrossProbeSchToPcb(), D_PAD::D_PAD(), FOOTPRINT_EDIT_FRAME::Delete_Edge_Module(), PCB_EDIT_FRAME::Delete_Segment_Edge(), SCH_SCREENS::DeleteAllMarkers(), SCH_SCREEN::DeleteItem(), LIB_EDIT_FRAME::deleteItem(), deleteItem(), SCH_EDIT_FRAME::DeleteItem(), DeleteItemsInList(), DeleteNullTrackSegments(), DIALOG_SCH_EDIT_ONE_FIELD::DIALOG_SCH_EDIT_ONE_FIELD(), DIALOG_ERC::DisplayERC_MarkersList(), DRC::doTrackDrc(), DRC::doTrackKeepoutDrc(), KIGFX::GERBVIEW_PAINTER::Draw(), KIGFX::PCB_PAINTER::Draw(), KIGFX::PCB_PAINTER::draw(), DrawMovePin(), DrawMovingBlockOutlines(), drawPickedItems(), CN_ITEM::Dump(), BOARD::Duplicate(), MODULE::Duplicate(), PCB_EDIT_FRAME::duplicateItems(), DuplicateItemsInList(), SCH_EDIT_FRAME::EditComponent(), SCH_EDIT_FRAME::EditComponentFieldText(), LIB_EDIT_FRAME::EditSymbolText(), SCH_EDIT_FRAME::EndSegment(), PCB_EDIT_FRAME::EraseRedundantTrack(), ExitSheet(), SCH_SCREEN::ExtractWires(), DRC::fillMarker(), find_vias_and_tracks_at(), SCH_EDIT_FRAME::FindComponentAndItem(), NETLIST_EXPORTER::findNextComponent(), NETLIST_EXPORTER::findNextComponentAndCreatePinList(), SCH_SHEET_PATH::FindNextItem(), SCH_SHEET_LIST::FindNextItem(), SCH_SHEET_PATH::FindPreviousItem(), SCH_SHEET_LIST::FindPreviousItem(), POINT_EDITOR::finishItem(), FootprintWriteShape(), PCB_IO::Format(), PCB_IO::format(), FormatProbeItem(), POINT_EDITOR::get45DegConstrainer(), getAnchorPoint(), TRACK::GetBestInsertPoint(), BOARD_ITEM::GetBoard(), TRACK::GetBoundingBox(), BOARD_CONNECTED_ITEM::GetClearance(), NETLIST_OBJECT::GetComponentParent(), SCH_SCREEN::GetConnection(), SCH_TEXT::GetConnectionPoints(), SCH_TEXT::GetEndPoints(), SCH_SHEET::GetEndPoints(), GetFirstTrack(), GetFirstVia(), SCH_SCREEN::GetHierarchicalItems(), TEXTE_PCB::GetMsgPanelInfo(), SCH_TEXT::GetMsgPanelInfo(), BOARD_CONNECTED_ITEM::GetNetClass(), CONNECTIVITY_DATA::GetNetItems(), LIB_PART::GetNextDrawItem(), DRAWSEGMENT::GetParentModule(), SCH_SCREEN::GetPin(), LIB_PART::GetPin(), SCH_COMPONENT::GetPinPhysicalPosition(), getRect(), SELECTION::GetTopLeftItem(), LIB_EDIT_FRAME::GlobalSetPins(), SELECTION_TOOL::guessSelectionCandidates(), SCH_SCREENS::HasNoFullyDefinedLibIds(), SCH_SHEET::HasUndefinedPins(), SCH_EDIT_FRAME::ImportSheetPin(), DIALOG_LABEL_EDITOR::InitDialog(), ROUTER_TOOL::InlineDrag(), SCH_COLLECTOR::Inspect(), GENERAL_COLLECTOR::Inspect(), SCH_FIND_COLLECTOR::Inspect(), ARRAY_CREATOR::Invoke(), SCH_TEXT::IsDanglingStateChanged(), SCH_COLLECTOR::IsDraggableJunction(), SCH_COLLECTOR::IsNode(), TRACK::IsNull(), SCH_SCREEN::IsTerminalPoint(), BOARD_ITEM::IsTrack(), itemIsIncludedByFilter(), CLIPBOARD_IO::Load(), SCH_SHEET::Load(), PNS_PCBNEW_RULE_RESOLVER::localPadClearance(), SCH_EDIT_FRAME::LocateAndShowItem(), SCH_EDIT_FRAME::LocateItem(), SCH_SHEET::LocatePathOfScreen(), Magnetize(), EDIT_POINTS_FACTORY::Make(), SCH_SCREEN::MarkConnections(), CONNECTIVITY_DATA::MarkItemNetAsDirty(), CN_CONNECTIVITY_ALGO::markItemNetAsDirty(), MarkItemsInBloc(), BOARD::MarkTrace(), TRACKS_CLEANER::mergeCollinearSegmentIfPossible(), TRACKS_CLEANER::MergeCollinearTracks(), SCH_LINE::MergeOverlap(), FOOTPRINT_EDIT_FRAME::ModeditLocateAndDisplay(), moveItemWithMouseCursor(), MoveMarkedItems(), MoveMarkedItemsExactly(), SCH_EDIT_FRAME::OnConvertTextType(), SCH_EDIT_FRAME::OnCopySchematicItemRequest(), SCH_EDIT_FRAME::OnDragItem(), SCH_EDIT_FRAME::OnEditItem(), FOOTPRINT_EDIT_FRAME::OnEditItemRequest(), PCB_EDIT_FRAME::OnEditItemRequest(), LIB_EDIT_FRAME::OnEditPin(), LIB_EDIT_FRAME::OnHotKey(), SCH_EDIT_FRAME::OnHotKey(), PCB_EDIT_FRAME::OnHotkeyCopyItem(), FOOTPRINT_EDIT_FRAME::OnHotkeyDeleteItem(), PCB_EDIT_FRAME::OnHotkeyDeleteItem(), FOOTPRINT_EDIT_FRAME::OnHotkeyDuplicateItem(), PCB_EDIT_FRAME::OnHotkeyDuplicateOrArrayItem(), FOOTPRINT_EDIT_FRAME::OnHotkeyEditItem(), PCB_EDIT_FRAME::OnHotkeyEditItem(), PCB_EDIT_FRAME::OnHotkeyFlipItem(), FOOTPRINT_EDIT_FRAME::OnHotkeyMoveItem(), PCB_EDIT_FRAME::OnHotkeyMoveItem(), FOOTPRINT_EDIT_FRAME::OnHotkeyMoveItemExact(), PCB_EDIT_FRAME::OnHotkeyPlaceItem(), FOOTPRINT_EDIT_FRAME::OnHotkeyRotateItem(), PCB_EDIT_FRAME::OnHotkeyRotateItem(), FOOTPRINT_EDIT_FRAME::OnLeftClick(), LIB_EDIT_FRAME::OnLeftClick(), SCH_EDIT_FRAME::OnLeftClick(), PCB_EDIT_FRAME::OnLeftClick(), LIB_EDIT_FRAME::OnLeftDClick(), SCH_EDIT_FRAME::OnLeftDClick(), PCB_EDIT_FRAME::OnLeftDClick(), SCH_EDIT_FRAME::OnMoveItem(), SCH_EDIT_FRAME::OnOpenLibraryEditor(), SCH_EDIT_FRAME::OnOrient(), FOOTPRINT_EDIT_FRAME::OnRightClick(), LIB_EDIT_FRAME::OnRightClick(), SCH_EDIT_FRAME::OnRightClick(), PCB_EDIT_FRAME::OnRightClick(), SCH_EDIT_FRAME::OnRotate(), SCH_EDIT_FRAME::OnSelectUnit(), SCH_LINE::operator<(), LIB_ITEM::operator<(), SCH_ITEM::operator<(), SCH_COMPONENT::operator<(), SCH_BITMAP::operator=(), SCH_SHEET::operator=(), SCH_COMPONENT::operator=(), LIB_ITEM::operator==(), OrCell_Trace(), SCH_EDIT_FRAME::OrientComponent(), BOARD_COMMIT::parentObject(), PCBNEW_CONTROL::PasteItemsFromClipboard(), SCH_EDIT_FRAME::PasteListOfItems(), PCB_BASE_FRAME::PcbGeneralLocateAndDisplay(), LIB_EDIT_FRAME::PlacePin(), SCH_FIELD::Plot(), BRDITEMS_PLOTTER::Plot_1_EdgeModule(), SCH_EDIT_FRAME::PrepareMoveItem(), GAL_ARRAY_CREATOR::prePushAction(), PCB_EDIT_FRAME::PrintPage(), FOOTPRINT_EDIT_FRAME::Process_Special_Functions(), LIB_EDIT_FRAME::Process_Special_Functions(), SCH_EDIT_FRAME::Process_Special_Functions(), PCB_EDIT_FRAME::Process_Special_Functions(), BOARD_COMMIT::Push(), PCB_BASE_EDIT_FRAME::PutDataInPreviousState(), RedrawWhileMovingCursor(), DIALOG_SYMBOL_REMAP::remapSymbolsToLibTable(), MODULE::Remove(), BOARD::Remove(), CN_CONNECTIVITY_ALGO::Remove(), POINT_EDITOR::removeCorner(), POINT_EDITOR::removeCornerCondition(), LIB_PART::RemoveDrawItem(), TRACKS_CLEANER::removeDuplicatesOfTrack(), SCH_SHEET::RemovePin(), FOOTPRINT_EDIT_FRAME::RemoveStruct(), PCB_EDIT_FRAME::RemoveStruct(), SCH_EDIT_FRAME::RepeatDrawItem(), LIB_EDIT_FRAME::RepeatPinItem(), SCH_SCREENS::ReplaceDuplicateTimeStamps(), SCH_SCREEN::ReplaceWires(), GERBVIEW_SELECTION_TOOL::RequestSelection(), SELECTION_TOOL::RequestSelection(), PCB_EDIT_FRAME::Reset_All_Tracks_And_Vias_To_Netclass_Values(), PCB_BASE_FRAME::ResetTextSize(), SCH_EDIT_FRAME::ReSizeSheet(), BOARD_COMMIT::Revert(), SCH_EDIT_FRAME::RotateField(), PCB_BASE_EDIT_FRAME::SaveCopyInUndoList(), SCH_EDIT_FRAME::SaveUndoItemInUndoList(), CN_CONNECTIVITY_ALGO::searchConnections(), SCH_SHEET::SearchHierarchy(), SELECTION_TOOL::select(), SELECTION_TOOL::selectable(), SCH_SCREEN::SelectBlockItems(), PCB_EDIT_FRAME::SelectHighLight(), SELECTION_TOOL::selectVisually(), ITEM_PICKER::SetItem(), SetSchItemParent(), DIALOG_LABEL_EDITOR::SetTitle(), PCB_EDIT_FRAME::SetTrackSegmentWidth(), PCB_EDIT_FRAME::Show_1_Ratsnest(), Show_MoveNode(), ShowClearance(), ShowNewTrackWhenMovingCursor(), SortByTimeStamp(), PCB_EDIT_FRAME::Start_DragTrackSegmentAndKeepSlope(), LIB_EDIT_FRAME::StartMoveDrawSymbol(), PCB_EDIT_FRAME::StartMoveOneNodeOrSegment(), SCH_JUNCTION::SwapData(), SCH_NO_CONNECT::SwapData(), SCH_BITMAP::SwapData(), SCH_FIELD::SwapData(), SCH_SHEET_PIN::SwapData(), BOARD_ITEM::SwapData(), SCH_SHEET::SwapData(), SCH_COMPONENT::SwapData(), PCB_EDIT_FRAME::SwitchLayer(), TestDuplicateSheetNames(), TRACKS_CLEANER::testTrackEndpointDangling(), TEXTE_MODULE::TEXTE_MODULE(), TraceSegmentPcb(), TRACK::TransformShapeWithClearanceToPolygon(), SELECTION_TOOL::unselectVisually(), SCH_SHEET_PATH::UpdateAllScreenReferences(), DIALOG_SCH_EDIT_ONE_FIELD::UpdateField(), POINT_EDITOR::updateItem(), POINT_EDITOR::updatePoints(), PCB_BRIGHT_BOX::ViewDraw(), TRACK::Visit(), GERBER_DRAW_ITEM::Visit(), EDA_ITEM::Visit(), SCH_SHEET::Visit(), and SCH_COMPONENT::Visit().

213  {
214  return m_StructType;
215  }
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
const BOX2I EDA_ITEM::ViewBBox ( ) const
overridevirtualinherited

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

Returns
BOX2I - the current bounding box

Implements KIGFX::VIEW_ITEM.

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

Definition at line 267 of file base_struct.cpp.

References EDA_ITEM::GetBoundingBox().

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

268 {
269  // Basic fallback
270  return BOX2I( VECTOR2I( GetBoundingBox().GetOrigin() ),
271  VECTOR2I( GetBoundingBox().GetSize() ) );
272 }
virtual const EDA_RECT GetBoundingBox() const
Function GetBoundingBox returns the orthogonal, bounding box of this object for display purposes...
BOX2< VECTOR2I > BOX2I
Definition: box2.h:468
VECTOR2< int > VECTOR2I
Definition: vector2d.h:590
virtual void KIGFX::VIEW_ITEM::ViewDraw ( int  aLayer,
VIEW aView 
) const
inlinevirtualinherited

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

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

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

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

Definition at line 115 of file view_item.h.

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

116  {}
void EDA_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[]

Implements KIGFX::VIEW_ITEM.

Reimplemented in D_PAD, MODULE, EDIT_POINTS, VIA, BOARD_ITEM, TRACK, GERBER_DRAW_ITEM, TEXTE_MODULE, ZONE_CONTAINER, MARKER_PCB, KIGFX::WORKSHEET_VIEWITEM, ROUTER_PREVIEW_ITEM, KIGFX::PREVIEW::SIMPLE_OVERLAY_ITEM, BRIGHT_BOX, KIGFX::ORIGIN_VIEWITEM, KIGFX::RATSNEST_VIEWITEM, and KIGFX::PREVIEW::RULER_ITEM.

Definition at line 275 of file base_struct.cpp.

276 {
277  // Basic fallback
278  aCount = 1;
279  aLayers[0] = 0;
280 }
virtual unsigned int KIGFX::VIEW_ITEM::ViewGetLOD ( int  aLayer,
VIEW aView 
) const
inlinevirtualinherited

Function ViewGetLOD() Returns the level of detail 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.

Reimplemented in D_PAD, MODULE, VIA, GERBER_DRAW_ITEM, TRACK, and TEXTE_MODULE.

Definition at line 134 of file view_item.h.

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

135  {
136  // By default always show the item
137  return 0;
138  }
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, SCH_SHEET, MODULE, GERBER_FILE_IMAGE, GERBER_DRAW_ITEM, TRACK, and GBR_LAYOUT.

Definition at line 151 of file base_struct.cpp.

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

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

152 {
153  KICAD_T stype;
154 
155 #if 0 && defined(DEBUG)
156  std::cout << GetClass().mb_str() << ' ';
157 #endif
158 
159  for( const KICAD_T* p = scanTypes; (stype = *p) != EOT; ++p )
160  {
161  // If caller wants to inspect my type
162  if( stype == Type() )
163  {
164  if( SEARCH_QUIT == inspector( this, testData ) )
165  return SEARCH_QUIT;
166 
167  break;
168  }
169  }
170 
171  return SEARCH_CONTINUE;
172 }
KICAD_T Type() const
Function Type()
Definition: base_struct.h:212
search types array terminator (End Of Types)
Definition: typeinfo.h:94
KICAD_T
Enum KICAD_T is the set of class identification values, stored in EDA_ITEM::m_StructType.
Definition: typeinfo.h:90
virtual wxString GetClass() const =0
Function GetClass returns the class name.

Member Data Documentation

double LIB_ARC::m_editCenterDistance
private

Definition at line 54 of file lib_arc.h.

Referenced by BeginEdit(), calcEdit(), and LIB_ARC().

int LIB_ARC::m_editDirection
private

Definition at line 57 of file lib_arc.h.

Referenced by BeginEdit(), calcEdit(), and LIB_ARC().

SELECT_T LIB_ARC::m_editSelectPoint
private

Definition at line 55 of file lib_arc.h.

Referenced by BeginEdit(), calcEdit(), and LIB_ARC().

int LIB_ARC::m_editState
private

Definition at line 56 of file lib_arc.h.

Referenced by BeginEdit(), calcEdit(), ContinueEdit(), EndEdit(), and LIB_ARC().

STATUS_FLAGS EDA_ITEM::m_Flags
protectedinherited

Flag bits for editing and other uses.

Definition at line 189 of file base_struct.h.

Referenced by LIB_CIRCLE::BeginEdit(), LIB_RECTANGLE::BeginEdit(), LIB_POLYLINE::BeginEdit(), LIB_TEXT::BeginEdit(), BeginEdit(), LIB_FIELD::BeginEdit(), LIB_CIRCLE::calcEdit(), LIB_POLYLINE::calcEdit(), LIB_RECTANGLE::calcEdit(), LIB_TEXT::calcEdit(), calcEdit(), LIB_FIELD::calcEdit(), LIB_TEXT::Clone(), LIB_CIRCLE::ContinueEdit(), LIB_RECTANGLE::ContinueEdit(), LIB_POLYLINE::ContinueEdit(), LIB_TEXT::ContinueEdit(), ContinueEdit(), LIB_FIELD::ContinueEdit(), SCH_LINE::Draw(), TRACK::Draw(), DRAWSEGMENT::Draw(), MODULE::Draw(), SEGZONE::Draw(), D_PAD::Draw(), LIB_CIRCLE::drawGraphic(), LIB_POLYLINE::drawGraphic(), LIB_RECTANGLE::drawGraphic(), LIB_BEZIER::drawGraphic(), drawGraphic(), DRAWSEGMENT::DRAWSEGMENT(), LIB_CIRCLE::EndEdit(), LIB_RECTANGLE::EndEdit(), LIB_POLYLINE::EndEdit(), LIB_TEXT::EndEdit(), EndEdit(), LIB_ITEM::EndEdit(), LIB_FIELD::EndEdit(), EDA_ITEM::GetFlags(), TRACK::GetMsgPanelInfoBase_Common(), SCH_JUNCTION::HitTest(), SCH_LINE::HitTest(), SCH_COMPONENT::HitTest(), LIB_ITEM::InEditMode(), EDA_ITEM::initVars(), SCH_ITEM::IsConnected(), SCH_COMPONENT::Load(), SCH_LINE::Move(), EDA_ITEM::operator=(), SCH_COMPONENT::SCH_COMPONENT(), LIB_PIN::SetConversion(), LIB_PIN::SetLength(), LIB_PIN::SetName(), LIB_PIN::SetNameTextSize(), LIB_PIN::SetNumberTextSize(), LIB_PIN::SetOrientation(), LIB_PIN::SetPartNumber(), LIB_PIN::SetPinPosition(), LIB_PIN::SetShape(), LIB_PIN::SetType(), and LIB_PIN::SetVisible().

bool EDA_ITEM::m_forceVisible
protectedinherited

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

Definition at line 186 of file base_struct.h.

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

bool LIB_ITEM::m_isFillable
protectedinherited

Flag to indicate if draw item is fillable.

Default is false.

Definition at line 140 of file lib_draw_item.h.

Referenced by LIB_ITEM::IsFillable(), LIB_ARC(), LIB_BEZIER::LIB_BEZIER(), LIB_CIRCLE::LIB_CIRCLE(), LIB_ITEM::LIB_ITEM(), LIB_POLYLINE::LIB_POLYLINE(), and LIB_RECTANGLE::LIB_RECTANGLE().

int LIB_ARC::m_lastEditState
private

Definition at line 58 of file lib_arc.h.

Referenced by BeginEdit(), calcEdit(), drawEditGraphics(), drawGraphic(), EndEdit(), and LIB_ARC().

DHEAD* EDA_ITEM::m_List
protectedinherited

which DLIST I am on.

Definition at line 180 of file base_struct.h.

Referenced by EDA_ITEM::GetList(), EDA_ITEM::initVars(), and BOARD_ITEM::SwapData().

int LIB_ARC::m_Radius
private
int LIB_ARC::m_Width
private

Definition at line 53 of file lib_arc.h.

Referenced by GetMsgPanelInfo(), GetPenSize(), GetWidth(), LIB_ARC(), Load(), and Save().


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