KiCad PCB EDA Suite
EDGE_MODULE Class Reference

#include <class_edge_mod.h>

Inheritance diagram for EDGE_MODULE:
DRAWSEGMENT BOARD_ITEM EDA_ITEM KIGFX::VIEW_ITEM

Public Member Functions

 EDGE_MODULE (MODULE *parent, STROKE_T aShape=S_SEGMENT)
 
 ~EDGE_MODULE ()
 
void Move (const wxPoint &aMoveVector) override
 Move an edge of the footprint. More...
 
void Mirror (const wxPoint aCentre, bool aMirrorAroundXAxis)
 Mirror an edge of the footprint. More...
 
void Rotate (const wxPoint &aRotCentre, double aAngle) override
 Rotate an edge of the footprint. More...
 
void Flip (const wxPoint &aCentre) override
 Flip entity relative to aCentre. More...
 
bool IsParentFlipped () const
 
void SetStart0 (const wxPoint &aPoint)
 
const wxPoint & GetStart0 () const
 
void SetEnd0 (const wxPoint &aPoint)
 
const wxPoint & GetEnd0 () const
 
void SetBezier0_C1 (const wxPoint &aPoint)
 
const wxPoint & GetBezier0_C1 () const
 
void SetBezier0_C2 (const wxPoint &aPoint)
 
const wxPoint & GetBezier0_C2 () const
 
void SetLocalCoord ()
 Set relative coordinates from draw coordinates. More...
 
void SetDrawCoord ()
 Set draw coordinates (absolute values ) from relative coordinates. More...
 
void Draw (EDA_DRAW_PANEL *panel, wxDC *DC, GR_DRAWMODE aDrawMode, const wxPoint &offset=ZeroOffset) override
 Function Draw BOARD_ITEMs have their own color information. More...
 
void GetMsgPanelInfo (EDA_UNITS_T aUnits, std::vector< MSG_PANEL_ITEM > &aList) override
 Function GetMsgPanelInfo populates aList of MSG_PANEL_ITEM objects with it's internal state for display purposes. More...
 
wxString GetClass () const override
 Function GetClass returns the class name. More...
 
wxString GetSelectMenuText (EDA_UNITS_T aUnits) const override
 Function GetSelectMenuText returns the text to display to be used in the selection clarification context menu when multiple items are found at the current cursor position. More...
 
BITMAP_DEF GetMenuImage () const override
 Function GetMenuImage returns a pointer to an image to be used in menus. More...
 
EDA_ITEMClone () const override
 Function Clone creates a duplicate of this item with linked list members set to NULL. More...
 
virtual unsigned int ViewGetLOD (int aLayer, KIGFX::VIEW *aView) const override
 Function ViewGetLOD() Returns the level of detail (LOD) of the item. More...
 
bool IsPolygonFilled () const
 Polygonal shape is not always filled. More...
 
void SetWidth (int aWidth)
 
int GetWidth () const
 
void SetAngle (double aAngle)
 Function SetAngle sets the angle for arcs, and normalizes it within the range 0 - 360 degrees. More...
 
double GetAngle () const
 
void SetType (int aType)
 
int GetType () const
 
void SetShape (STROKE_T aShape)
 
STROKE_T GetShape () const
 
void SetBezControl1 (const wxPoint &aPoint)
 
const wxPoint & GetBezControl1 () const
 
void SetBezControl2 (const wxPoint &aPoint)
 
const wxPoint & GetBezControl2 () const
 
void SetPosition (const wxPoint &aPos) override
 
const wxPoint GetPosition () const override
 
const wxPoint & GetStart () const
 Function GetStart returns the starting point of the graphic. More...
 
void SetStart (const wxPoint &aStart)
 
void SetStartY (int y)
 
void SetStartX (int x)
 
const wxPoint & GetEnd () const
 Function GetEnd returns the ending point of the graphic. More...
 
void SetEnd (const wxPoint &aEnd)
 
void SetEndY (int y)
 
void SetEndX (int x)
 
const wxPoint GetCenter () const override
 Function GetCenter() More...
 
const wxPoint & GetArcStart () const
 
const wxPoint GetArcEnd () const
 
const wxPoint GetArcMid () const
 
double GetArcAngleStart () const
 function GetArcAngleStart() More...
 
int GetRadius () const
 Function GetRadius returns the radius of this item Has meaning only for arc and circle. More...
 
void SetArcStart (const wxPoint &aArcStartPoint)
 Initialize the start arc point. More...
 
void SetCenter (const wxPoint &aCenterPoint)
 For arcs and circles: More...
 
MODULEGetParentModule () const
 Function GetParentModule returns a pointer to the parent module, or NULL if DRAWSEGMENT does not belong to a module. More...
 
const std::vector< wxPoint > & GetBezierPoints () const
 
const std::vector< wxPoint > BuildPolyPointsList () const
 Build and return the list of corners in a std::vector<wxPoint> It must be used only to convert the SHAPE_POLY_SET internal corner buffer to a list of wxPoints, and nothing else, because it duplicates the buffer, that is inefficient to know for instance the corner count. More...
 
int GetPointCount () const
 
SHAPE_POLY_SETGetPolyShape ()
 
const SHAPE_POLY_SETGetPolyShape () const
 
bool IsPolyShapeValid () const
 
void SetPolyShape (const SHAPE_POLY_SET &aShape)
 
void SetBezierPoints (const std::vector< wxPoint > &aPoints)
 
void RebuildBezierToSegmentsPointsList (int aMinSegLen)
 Rebuild the m_BezierPoints vertex list that approximate the Bezier curve by a list of segments Has meaning only for S_CURVE DRAW_SEGMENT shape. More...
 
void SetPolyPoints (const std::vector< wxPoint > &aPoints)
 
const EDA_RECT GetBoundingBox () const override
 Function GetBoundingBox returns the orthogonal, bounding box of this object for display purposes. More...
 
bool HitTest (const wxPoint &aPosition, int aAccuracy=0) const override
 Function HitTest tests if aPosition is contained within or on the bounding box of an item. More...
 
bool HitTest (const EDA_RECT &aRect, bool aContained, int aAccuracy=0) const override
 Function HitTest tests if aRect intersects or is contained within the bounding box of an item. More...
 
double GetLength () const
 Function GetLength returns the length of the track using the hypotenuse calculation. More...
 
void Move (const VECTOR2I &aMoveVector)
 
void Rotate (const VECTOR2I &aRotCentre, double aAngle)
 
void Flip (const VECTOR2I &aCentre)
 
void TransformShapeWithClearanceToPolygon (SHAPE_POLY_SET &aCornerBuffer, int aClearanceValue, int aCircleToSegmentsCount, double aCorrectionFactor, bool ignoreLineWidth=false) const override
 Function TransformShapeWithClearanceToPolygon Convert the draw segment to a closed polygon Used in filling zones calculations Circles and arcs are approximated by segments. More...
 
virtual const BOX2I ViewBBox () const override
 Function ViewBBox() returns the bounding box of the item covering all its layers. More...
 
virtual void SwapData (BOARD_ITEM *aImage) override
 Swap data between aItem and aImage. More...
 
virtual bool IsConnected () const
 Function IsConnected() Returns information if the object is derived from BOARD_CONNECTED_ITEM. More...
 
BOARD_ITEMNext () const
 
BOARD_ITEMBack () const
 
BOARD_ITEM_CONTAINERGetParent () const
 
virtual PCB_LAYER_ID GetLayer () const
 Function GetLayer returns the primary layer this item is on. More...
 
virtual LSET GetLayerSet () const
 Function GetLayerSet returns a "layer mask", which is a bitmap of all layers on which the TRACK segment or VIA physically resides. More...
 
virtual void SetLayer (PCB_LAYER_ID aLayer)
 Function SetLayer sets the layer this item is on. More...
 
virtual bool IsOnLayer (PCB_LAYER_ID aLayer) const
 Function IsOnLayer tests to see if this object is on the given layer. More...
 
bool IsTrack () const
 Function IsTrack tests to see if this object is a track or via (or microvia). More...
 
virtual bool IsLocked () const
 Function IsLocked. More...
 
virtual void SetLocked (bool aLocked)
 Function SetLocked modifies 'lock' status for of the item. More...
 
virtual void UnLink ()
 Function UnLink detaches this object from its owner. More...
 
void DeleteStructure ()
 Function DeleteStructure deletes this object after UnLink()ing it from its owner if it has one. More...
 
virtual BOARDGetBoard () const
 Function GetBoard returns the BOARD in which this BOARD_ITEM resides, or NULL if none. More...
 
wxString GetLayerName () const
 Function GetLayerName returns the name of the PCB layer on which the item resides. More...
 
virtual void ViewGetLayers (int aLayers[], int &aCount) const override
 Function ViewGetLayers() Returns the all the layers within the VIEW the object is painted on. More...
 
KICAD_T Type () const
 Function Type() More...
 
void SetTimeStamp (timestamp_t aNewTimeStamp)
 
timestamp_t GetTimeStamp () const
 
DHEADGetList () const
 
void SetNext (EDA_ITEM *aNext)
 
void SetBack (EDA_ITEM *aBack)
 
void SetParent (EDA_ITEM *aParent)
 
void SetList (DHEAD *aList)
 
bool IsNew () const
 
bool IsModified () const
 
bool IsMoving () const
 
bool IsDragging () const
 
bool IsWireImage () const
 
bool IsSelected () const
 
bool IsResized () const
 
bool IsHighlighted () const
 
bool IsBrightened () const
 
void SetWireImage ()
 
void SetSelected ()
 
void SetHighlighted ()
 
void SetBrightened ()
 
void ClearSelected ()
 
void ClearHighlighted ()
 
void ClearBrightened ()
 
void SetModified ()
 
int GetState (int type) const
 
void SetState (int type, int state)
 
STATUS_FLAGS GetStatus () const
 
void SetStatus (STATUS_FLAGS aStatus)
 
void SetFlags (STATUS_FLAGS aMask)
 
void ClearFlags (STATUS_FLAGS aMask=EDA_ITEM_ALL_FLAGS)
 
STATUS_FLAGS GetFlags () const
 
STATUS_FLAGS GetEditFlags () const
 
void ClearTempFlags ()
 
void ClearEditFlags ()
 
virtual bool IsType (const KICAD_T aScanTypes[])
 Function IsType Checks whether the item is one of the listed types. More...
 
void SetForceVisible (bool aEnable)
 Function SetForceVisible is used to set and cleag force visible flag used to force the item to be drawn even if it's draw attribute is set to not visible. More...
 
virtual SEARCH_RESULT Visit (INSPECTOR inspector, void *testData, const KICAD_T scanTypes[])
 Function Visit may be re-implemented for each derived class in order to handle all the types given by its member data. More...
 
virtual bool Matches (wxFindReplaceData &aSearchData, void *aAuxData, 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...
 
bool operator< (const EDA_ITEM &aItem) const
 Test if another item is less than this object. More...
 
virtual void ViewDraw (int aLayer, VIEW *aView) const
 Function ViewDraw() Draws the parts of the object belonging to layer aLayer. More...
 
VIEW_ITEM_DATA * viewPrivData () const
 
void ClearViewPrivData ()
 

Static Public Member Functions

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

Public Attributes

wxPoint m_Start0
 Start point or center, relative to module origin, orient 0. More...
 
wxPoint m_End0
 End point, relative to module origin, orient 0. More...
 
wxPoint m_Bezier0_C1
 Bezier Control Point 1, relative to module origin, orient 0. More...
 
wxPoint m_Bezier0_C2
 Bezier Control Point 2, relative to module origin, orient 0. More...
 

Static Public Attributes

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

Protected Member Functions

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

Static Protected Member Functions

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

Protected Attributes

int m_Width
 thickness of lines ... More...
 
wxPoint m_Start
 Line start point or Circle and Arc center. More...
 
wxPoint m_End
 Line end point or circle and arc start point. More...
 
STROKE_T m_Shape
 Shape: line, Circle, Arc. More...
 
int m_Type
 Used in complex associations ( Dimensions.. ) More...
 
double m_Angle
 Used only for Arcs: Arc angle in 1/10 deg. More...
 
wxPoint m_BezierC1
 Bezier Control Point 1. More...
 
wxPoint m_BezierC2
 Bezier Control Point 2. More...
 
std::vector< wxPoint > m_BezierPoints
 
SHAPE_POLY_SET m_Poly
 Stores the S_POLYGON shape. More...
 
PCB_LAYER_ID m_Layer
 
EDA_ITEMPnext
 next in linked list More...
 
EDA_ITEMPback
 previous in linked list More...
 
DHEADm_List
 which DLIST I am on. More...
 
EDA_ITEMm_Parent
 Linked list: Link (parent struct) More...
 
timestamp_t m_TimeStamp
 Time stamp used for logical links. More...
 
bool m_forceVisible
 Set to true to override the visibility setting of the item. More...
 
STATUS_FLAGS m_Flags
 Flag bits for editing and other uses. More...
 

Detailed Description

Definition at line 44 of file class_edge_mod.h.

Constructor & Destructor Documentation

◆ EDGE_MODULE()

EDGE_MODULE::EDGE_MODULE ( MODULE parent,
STROKE_T  aShape = S_SEGMENT 
)

Definition at line 56 of file class_edge_mod.cpp.

56  :
58 {
59  m_Shape = aShape;
60  m_Angle = 0;
61  m_Layer = F_SilkS;
62 }
double m_Angle
Used only for Arcs: Arc angle in 1/10 deg.
class EDGE_MODULE, a footprint edge
Definition: typeinfo.h:94
PCB_LAYER_ID m_Layer
STROKE_T m_Shape
Shape: line, Circle, Arc.
DRAWSEGMENT(BOARD_ITEM *aParent=NULL, KICAD_T idtype=PCB_LINE_T)

References F_SilkS, DRAWSEGMENT::m_Angle, BOARD_ITEM::m_Layer, and DRAWSEGMENT::m_Shape.

Referenced by Clone().

◆ ~EDGE_MODULE()

EDGE_MODULE::~EDGE_MODULE ( )

Definition at line 65 of file class_edge_mod.cpp.

66 {
67 }

Member Function Documentation

◆ Back()

BOARD_ITEM* BOARD_ITEM::Back ( ) const
inlineinherited

Definition at line 116 of file class_board_item.h.

116 { return static_cast<BOARD_ITEM*>( Pback ); }
EDA_ITEM * Pback
previous in linked list
Definition: base_struct.h:171

References EDA_ITEM::Pback.

Referenced by SwapItemData().

◆ BuildPolyPointsList()

const std::vector< wxPoint > DRAWSEGMENT::BuildPolyPointsList ( ) const
inherited

Build and return the list of corners in a std::vector<wxPoint> It must be used only to convert the SHAPE_POLY_SET internal corner buffer to a list of wxPoints, and nothing else, because it duplicates the buffer, that is inefficient to know for instance the corner count.

Definition at line 978 of file class_drawsegment.cpp.

979 {
980  std::vector<wxPoint> rv;
981 
982  if( m_Poly.OutlineCount() )
983  {
984  if( m_Poly.COutline( 0 ).PointCount() )
985  {
986  for ( auto iter = m_Poly.CIterate(); iter; iter++ )
987  {
988  rv.push_back( wxPoint( iter->x, iter->y ) );
989  }
990  }
991  }
992 
993  return rv;
994 }
int OutlineCount() const
Returns the number of outlines in the set
SHAPE_POLY_SET m_Poly
Stores the S_POLYGON shape.
int PointCount() const
Function PointCount()
CONST_ITERATOR CIterate(int aFirst, int aLast, bool aIterateHoles=false) const
const SHAPE_LINE_CHAIN & COutline(int aIndex) const

References SHAPE_POLY_SET::CIterate(), SHAPE_POLY_SET::COutline(), DRAWSEGMENT::m_Poly, SHAPE_POLY_SET::OutlineCount(), and SHAPE_LINE_CHAIN::PointCount().

Referenced by GRID_HELPER::computeAnchors(), DIALOG_PAD_PROPERTIES::OnPaintShowPanel(), PCB_PARSER::parseD_PAD(), BRDITEMS_PLOTTER::Plot_1_EdgeModule(), PNS_KICAD_IFACE::syncGraphicalItem(), DRAWSEGMENT::TransformShapeWithClearanceToPolygon(), and POINT_EDITOR::updatePoints().

◆ ClassOf()

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

Definition at line 54 of file class_edge_mod.h.

55  {
56  return aItem && PCB_MODULE_EDGE_T == aItem->Type();
57  }
class EDGE_MODULE, a footprint edge
Definition: typeinfo.h:94
KICAD_T Type() const
Function Type()
Definition: base_struct.h:204

References PCB_MODULE_EDGE_T, and EDA_ITEM::Type().

◆ ClearBrightened()

void EDA_ITEM::ClearBrightened ( )
inlineinherited

Definition at line 239 of file base_struct.h.

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

References BRIGHTENED, and EDA_ITEM::ClearFlags().

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

◆ ClearEditFlags()

void EDA_ITEM::ClearEditFlags ( )
inlineinherited

◆ ClearFlags()

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

Definition at line 260 of file base_struct.h.

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

References EDA_ITEM::m_Flags.

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(), AbortMoveDimensionText(), AbortMoveTextModule(), FOOTPRINT_VIEWER_FRAME::AddFootprintToPCB(), PNS_KICAD_IFACE::AddItem(), PCB_EDIT_FRAME::Begin_DrawSegment(), FOOTPRINT_EDIT_FRAME::Begin_Edge_Module(), PCB_EDIT_FRAME::Begin_Zone(), PCB_EDIT_FRAME::Block_Delete(), PCB_EDIT_FRAME::Block_Flip(), PCB_EDIT_FRAME::Block_Move(), PCB_EDIT_FRAME::Change_Side_Module(), SCH_COMPONENT::ClearAllHighlightFlags(), SCH_SCREEN::ClearAnnotation(), EDA_ITEM::ClearBrightened(), EDA_ITEM::ClearEditFlags(), EDA_ITEM::ClearHighlighted(), ClearMarkItems(), clearModuleItemFlags(), EDA_ITEM::ClearSelected(), EDA_ITEM::ClearTempFlags(), SCH_EDIT_FRAME::ConvertPart(), LIB_EDIT_TOOL::Copy(), CopyMarkedItems(), MWAVE::CreateMicrowaveInductor(), FOOTPRINT_EDIT_FRAME::CreateTextModule(), PCB_EDIT_FRAME::Delete_LastCreatedCorner(), PCB_EDIT_FRAME::Delete_Segment_Edge(), DIALOG_LIB_EDIT_PIN::DIALOG_LIB_EDIT_PIN(), DIALOG_PAD_PROPERTIES::DIALOG_PAD_PROPERTIES(), KIGFX::SCH_PAINTER::draw(), SCH_ITEM::Duplicate(), 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_Route(), PCB_EDIT_FRAME::End_Zone(), PCB_EDIT_FRAME::Exchange_Module(), LIB_EDIT_FRAME::GetComponentFromRedoList(), LIB_EDIT_FRAME::GetComponentFromUndoList(), SCH_MOVE_TOOL::getConnectedDragItems(), PCB_BASE_FRAME::Import_Pad_Settings(), FOOTPRINT_EDIT_FRAME::Load_Module_From_BOARD(), EDIT_POINTS_FACTORY::Make(), MarkItemsInBloc(), FOOTPRINT_EDIT_FRAME::OnLeftClick(), PCB_EDIT_FRAME::OnLeftClick(), 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(), BOARD_COMMIT::Push(), SCH_EDIT_TOOL::RepeatDrawItem(), LIB_PIN_TOOL::RepeatPin(), BOARD_COMMIT::Revert(), LIB_EDIT_FRAME::RollbackPartFromUndo(), PCB_BASE_FRAME::Rotate_Module(), SCH_EDIT_FRAME::SaveCopyForRepeatItem(), FOOTPRINT_EDIT_FRAME::SaveFootprintToBoard(), SCH_LEGACY_PLUGIN_CACHE::savePin(), SCH_EDIT_FRAME::SelectUnit(), PCB_EDIT_FRAME::Start_DragTrackSegmentAndKeepSlope(), PCB_EDIT_FRAME::StartMoveModule(), PCB_EDIT_FRAME::StartMoveOneNodeOrSegment(), DIALOG_EDIT_COMPONENT_IN_SCHEMATIC::TransferDataFromWindow(), and DIALOG_PAD_PROPERTIES::TransferDataFromWindow().

◆ ClearHighlighted()

void EDA_ITEM::ClearHighlighted ( )
inlineinherited

Definition at line 238 of file base_struct.h.

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

References EDA_ITEM::ClearFlags(), and HIGHLIGHTED.

◆ ClearSelected()

void EDA_ITEM::ClearSelected ( )
inlineinherited

◆ ClearTempFlags()

void EDA_ITEM::ClearTempFlags ( )
inlineinherited

Definition at line 271 of file base_struct.h.

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

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

Referenced by SCH_EDIT_FRAME::PutDataInPreviousState().

◆ ClearViewPrivData()

void KIGFX::VIEW_ITEM::ClearViewPrivData ( )
inlineinherited

Definition at line 153 of file view_item.h.

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

References KIGFX::VIEW_ITEM::m_viewPrivData.

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

◆ Clone()

EDA_ITEM * EDGE_MODULE::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 DRAWSEGMENT.

Definition at line 308 of file class_edge_mod.cpp.

309 {
310  return new EDGE_MODULE( *this );
311 }
EDGE_MODULE(MODULE *parent, STROKE_T aShape=S_SEGMENT)

References EDGE_MODULE().

◆ computeArcBBox()

void DRAWSEGMENT::computeArcBBox ( EDA_RECT aBBox) const
protectedinherited

Definition at line 891 of file class_drawsegment.cpp.

892 {
893  // Do not include the center, which is not necessarily
894  // inside the BB of a arc with a small angle
895  aBBox.SetOrigin( m_End );
896 
897  wxPoint end = m_End;
898  RotatePoint( &end, m_Start, -m_Angle );
899  aBBox.Merge( end );
900 
901  // Determine the starting quarter
902  // 0 right-bottom
903  // 1 left-bottom
904  // 2 left-top
905  // 3 right-top
906  unsigned int quarter = 0; // assume right-bottom
907 
908  if( m_End.x < m_Start.x )
909  {
910  if( m_End.y <= m_Start.y )
911  quarter = 2;
912  else // ( m_End.y > m_Start.y )
913  quarter = 1;
914  }
915  else if( m_End.x >= m_Start.x )
916  {
917  if( m_End.y < m_Start.y )
918  quarter = 3;
919  else if( m_End.x == m_Start.x )
920  quarter = 1;
921  }
922 
923  int radius = GetRadius();
924  int angle = (int) GetArcAngleStart() % 900 + m_Angle;
925  bool directionCW = ( m_Angle > 0 ); // Is the direction of arc clockwise?
926 
927  // Make the angle positive, so we go clockwise and merge points belonging to the arc
928  if( !directionCW )
929  {
930  angle = 900 - angle;
931  quarter = ( quarter + 3 ) % 4; // -1 modulo arithmetic
932  }
933 
934  while( angle > 900 )
935  {
936  switch( quarter )
937  {
938  case 0:
939  aBBox.Merge( wxPoint( m_Start.x, m_Start.y + radius ) ); // down
940  break;
941 
942  case 1:
943  aBBox.Merge( wxPoint( m_Start.x - radius, m_Start.y ) ); // left
944  break;
945 
946  case 2:
947  aBBox.Merge( wxPoint( m_Start.x, m_Start.y - radius ) ); // up
948  break;
949 
950  case 3:
951  aBBox.Merge( wxPoint( m_Start.x + radius, m_Start.y ) ); // right
952  break;
953  }
954 
955  if( directionCW )
956  ++quarter;
957  else
958  quarter += 3; // -1 modulo arithmetic
959 
960  quarter %= 4;
961  angle -= 900;
962  }
963 }
void Merge(const EDA_RECT &aRect)
Function Merge modifies the position and size of the rectangle in order to contain aRect.
double GetArcAngleStart() const
function GetArcAngleStart()
void SetOrigin(const wxPoint &pos)
Definition: eda_rect.h:124
void RotatePoint(int *pX, int *pY, double angle)
Definition: trigo.cpp:216
double m_Angle
Used only for Arcs: Arc angle in 1/10 deg.
wxPoint m_Start
Line start point or Circle and Arc center.
wxPoint m_End
Line end point or circle and arc start point.
int GetRadius() const
Function GetRadius returns the radius of this item Has meaning only for arc and circle.
static DIRECTION_45::AngleType angle(const VECTOR2I &a, const VECTOR2I &b)

References PNS::angle(), DRAWSEGMENT::GetArcAngleStart(), DRAWSEGMENT::GetRadius(), DRAWSEGMENT::m_Angle, DRAWSEGMENT::m_End, DRAWSEGMENT::m_Start, EDA_RECT::Merge(), RotatePoint(), and EDA_RECT::SetOrigin().

Referenced by DRAWSEGMENT::GetBoundingBox(), and DRAWSEGMENT::ViewBBox().

◆ DeleteStructure()

◆ Draw()

void EDGE_MODULE::Draw ( EDA_DRAW_PANEL panel,
wxDC *  DC,
GR_DRAWMODE  aDrawMode,
const wxPoint &  offset = ZeroOffset 
)
overridevirtual

Function Draw BOARD_ITEMs have their own color information.

Reimplemented from DRAWSEGMENT.

Definition at line 121 of file class_edge_mod.cpp.

123 {
124  int ux0, uy0, dx, dy, radius, StAngle, EndAngle;
125  PCB_LAYER_ID curr_layer = ( (PCB_SCREEN*) panel->GetScreen() )->m_Active_Layer;
126 
127  MODULE* module = (MODULE*) m_Parent;
128 
129  if( !module )
130  return;
131 
132  BOARD* brd = GetBoard( );
133 
134  if( brd->IsLayerVisible( m_Layer ) == false )
135  return;
136 
137 
138  auto frame = static_cast<PCB_BASE_FRAME*> ( panel->GetParent() );
139  auto color = frame->Settings().Colors().GetLayerColor( m_Layer );
140 
141  auto displ_opts = (PCB_DISPLAY_OPTIONS*)( panel->GetDisplayOptions() );
142 
143  if(( draw_mode & GR_ALLOW_HIGHCONTRAST ) && displ_opts && displ_opts->m_ContrastModeDisplay )
144  {
145  if( !IsOnLayer( curr_layer ) )
147  }
148 
149  ux0 = m_Start.x - offset.x;
150  uy0 = m_Start.y - offset.y;
151 
152  dx = m_End.x - offset.x;
153  dy = m_End.y - offset.y;
154 
155  GRSetDrawMode( DC, draw_mode );
156  bool filled = displ_opts ? displ_opts->m_DisplayModEdgeFill : FILLED;
157 
158  if( IsCopperLayer( m_Layer ) )
159  filled = displ_opts ? displ_opts->m_DisplayPcbTrackFill : FILLED;
160 
161  switch( m_Shape )
162  {
163  case S_SEGMENT:
164  if( filled )
165  GRLine( panel->GetClipBox(), DC, ux0, uy0, dx, dy, m_Width, color );
166  else
167  // SKETCH Mode
168  GRCSegm( panel->GetClipBox(), DC, ux0, uy0, dx, dy, m_Width, color );
169 
170  break;
171 
172  case S_CIRCLE:
173  radius = KiROUND( Distance( ux0, uy0, dx, dy ) );
174 
175  if( filled )
176  {
177  GRCircle( panel->GetClipBox(), DC, ux0, uy0, radius, m_Width, color );
178  }
179  else // SKETCH Mode
180  {
181  GRCircle( panel->GetClipBox(), DC, ux0, uy0, radius + (m_Width / 2), color );
182  GRCircle( panel->GetClipBox(), DC, ux0, uy0, radius - (m_Width / 2), color );
183  }
184 
185  break;
186 
187  case S_ARC:
188  radius = KiROUND( Distance( ux0, uy0, dx, dy ) );
189  StAngle = ArcTangente( dy - uy0, dx - ux0 );
190  EndAngle = StAngle + m_Angle;
191 
192  if( !panel->GetPrintMirrored() )
193  {
194  if( StAngle > EndAngle )
195  std::swap( StAngle, EndAngle );
196  }
197  else // Mirrored mode: arc orientation is reversed
198  {
199  if( StAngle < EndAngle )
200  std::swap( StAngle, EndAngle );
201  }
202 
203  if( filled )
204  {
205  GRArc( panel->GetClipBox(), DC, ux0, uy0, StAngle, EndAngle, radius, m_Width, color );
206  }
207  else // SKETCH Mode
208  {
209  GRArc( panel->GetClipBox(), DC, ux0, uy0, StAngle, EndAngle,
210  radius + (m_Width / 2), color );
211  GRArc( panel->GetClipBox(), DC, ux0, uy0, StAngle, EndAngle,
212  radius - (m_Width / 2), color );
213  }
214  break;
215 
216  case S_POLYGON:
217  if( m_Poly.IsEmpty() )
218  break;
219 
220  {
221  // We must compute absolute coordinates from m_PolyPoints
222  // which are relative to module position, orientation 0
223  std::vector<wxPoint> points;
224 
225  for( auto iter = m_Poly.CIterate(); iter; iter++ )
226  {
227  points.push_back( wxPoint( iter->x,iter->y ) );
228  }
229 
230  for( unsigned ii = 0; ii < points.size(); ii++ )
231  {
232  wxPoint& pt = points[ii];
233 
234  RotatePoint( &pt.x, &pt.y, module->GetOrientation() );
235  pt += module->GetPosition() - offset;
236  }
237 
238  GRPoly( panel->GetClipBox(), DC, points.size(), &points[0], true, m_Width, color, color );
239  }
240  break;
241 
242  case S_CURVE:
243  {
245 
246  wxPoint& startp = m_BezierPoints[0];
247 
248  for( unsigned int i = 1; i < m_BezierPoints.size(); i++ )
249  {
250  wxPoint& endp = m_BezierPoints[i];
251 
252  if( filled )
253  GRFilledSegment( panel->GetClipBox(), DC,
254  startp-offset, endp-offset, m_Width, color );
255  else
256  GRCSegm( panel->GetClipBox(), DC,
257  startp-offset, endp-offset, m_Width, color );
258 
259  startp = m_BezierPoints[i];
260  }
261  }
262  break;
263 
264  default:
265  break;
266  }
267 }
virtual BASE_SCREEN * GetScreen()=0
double GetOrientation() const
Definition: class_module.h:188
void GRPoly(EDA_RECT *ClipBox, wxDC *DC, int n, wxPoint Points[], bool Fill, int width, COLOR4D Color, COLOR4D BgColor)
Definition: gr_basic.cpp:701
EDA_ITEM * m_Parent
Linked list: Link (parent struct)
Definition: base_struct.h:174
void GRSetDrawMode(wxDC *DC, GR_DRAWMODE draw_mode)
Definition: gr_basic.cpp:223
static int KiROUND(double v)
Round a floating point number to an integer using "round halfway cases away from zero".
Definition: common.h:118
SHAPE_POLY_SET m_Poly
Stores the S_POLYGON shape.
int color
Definition: DXF_plotter.cpp:62
polygon (not yet used for tracks, but could be in microwave apps)
bool IsEmpty() const
Returns true if the set is empty (no polygons at all)
void RebuildBezierToSegmentsPointsList(int aMinSegLen)
Rebuild the m_BezierPoints vertex list that approximate the Bezier curve by a list of segments Has me...
void GRCSegm(EDA_RECT *ClipBox, wxDC *DC, int x1, int y1, int x2, int y2, int width, int aPenSize, COLOR4D Color)
Definition: gr_basic.cpp:415
usual segment : line with rounded ends
virtual EDA_RECT * GetClipBox()
void RotatePoint(int *pX, int *pY, double angle)
Definition: trigo.cpp:216
double m_Angle
Used only for Arcs: Arc angle in 1/10 deg.
virtual EDA_DRAW_FRAME * GetParent() const =0
PCB_LAYER_ID m_Layer
Class PCB_DISPLAY_OPTIONS handles display options like enable/disable some optional drawings.
PCB_LAYER_ID
A quick note on layer IDs:
wxPoint m_Start
Line start point or Circle and Arc center.
virtual bool IsOnLayer(PCB_LAYER_ID aLayer) const
Function IsOnLayer tests to see if this object is on the given layer.
double ArcTangente(int dy, int dx)
Definition: trigo.cpp:170
wxPoint m_End
Line end point or circle and arc start point.
Arcs (with rounded ends)
void GRArc(EDA_RECT *ClipBox, wxDC *DC, int xc, int yc, double StAngle, double EndAngle, int r, COLOR4D Color)
Definition: gr_basic.cpp:908
virtual BOARD * GetBoard() const
Function GetBoard returns the BOARD in which this BOARD_ITEM resides, or NULL if none.
STROKE_T m_Shape
Shape: line, Circle, Arc.
Bezier Curve.
void GRLine(EDA_RECT *ClipBox, wxDC *DC, int x1, int y1, int x2, int y2, int width, COLOR4D Color, wxPenStyle aStyle)
Definition: gr_basic.cpp:285
CONST_ITERATOR CIterate(int aFirst, int aLast, bool aIterateHoles=false) const
bool IsLayerVisible(PCB_LAYER_ID aLayer) const
Function IsLayerVisible is a proxy function that calls the correspondent function in m_BoardSettings ...
Definition: class_board.h:453
Class BOARD holds information pertinent to a Pcbnew printed circuit board.
Definition: class_board.h:170
void GRFilledSegment(EDA_RECT *aClipBox, wxDC *aDC, wxPoint aStart, wxPoint aEnd, int aWidth, COLOR4D aColor)
Definition: gr_basic.cpp:526
void GRCircle(EDA_RECT *ClipBox, wxDC *DC, int xc, int yc, int r, int width, COLOR4D Color)
Definition: gr_basic.cpp:755
size_t i
Definition: json11.cpp:597
bool IsCopperLayer(LAYER_NUM aLayerId)
Function IsCopperLayer tests whether a layer is a copper layer.
int m_Width
thickness of lines ...
virtual void * GetDisplayOptions()
Function GetDisplayOptions A way to pass info to draw functions.
double Distance(double x1, double y1, double x2, double y2)
const wxPoint GetPosition() const override
Definition: class_module.h:183
std::vector< wxPoint > m_BezierPoints
Class COLOR4D is the color representation with 4 components: red, green, blue, alpha.
Definition: color4d.h:39

References ArcTangente(), SHAPE_POLY_SET::CIterate(), color, DARKDARKGRAY, Distance(), FILLED, BOARD_ITEM::GetBoard(), EDA_DRAW_PANEL::GetClipBox(), EDA_DRAW_PANEL::GetDisplayOptions(), MODULE::GetOrientation(), EDA_DRAW_PANEL::GetParent(), MODULE::GetPosition(), EDA_DRAW_PANEL::GetPrintMirrored(), EDA_DRAW_PANEL::GetScreen(), GR_ALLOW_HIGHCONTRAST, GRArc(), GRCircle(), GRCSegm(), GRFilledSegment(), GRLine(), GRPoly(), GRSetDrawMode(), i, IsCopperLayer(), SHAPE_POLY_SET::IsEmpty(), BOARD::IsLayerVisible(), BOARD_ITEM::IsOnLayer(), KiROUND(), DRAWSEGMENT::m_Angle, DRAWSEGMENT::m_BezierPoints, DRAWSEGMENT::m_End, BOARD_ITEM::m_Layer, EDA_ITEM::m_Parent, DRAWSEGMENT::m_Poly, DRAWSEGMENT::m_Shape, DRAWSEGMENT::m_Start, DRAWSEGMENT::m_Width, DRAWSEGMENT::RebuildBezierToSegmentsPointsList(), RotatePoint(), S_ARC, S_CIRCLE, S_CURVE, S_POLYGON, and S_SEGMENT.

Referenced by Abort_Move_ModuleOutline(), FOOTPRINT_EDIT_FRAME::Begin_Edge_Module(), ShowCurrentOutlineWhileMoving(), ShowNewEdgeModule(), and FOOTPRINT_EDIT_FRAME::Start_Move_EdgeMod().

◆ Flip() [1/2]

void EDGE_MODULE::Flip ( const wxPoint &  aCentre)
overridevirtual

Flip entity relative to aCentre.

The item is mirrored, and layer changed to the paired corresponding layer if it is on a paired layer This function should be called only from MODULE::Flip because there is not usual to flip an item alone, without flipping the parent footprint. (consider Mirror for a mirror transform).

Reimplemented from DRAWSEGMENT.

Definition at line 314 of file class_edge_mod.cpp.

315 {
316  wxPoint pt;
317 
318  switch( GetShape() )
319  {
320  case S_ARC:
321  SetAngle( -GetAngle() );
322  //Fall through
323  default:
324  case S_SEGMENT:
325  case S_CURVE:
326  pt = GetStart();
327  MIRROR( pt.y, aCentre.y );
328  SetStart( pt );
329 
330  pt = GetEnd();
331  MIRROR( pt.y, aCentre.y );
332  SetEnd( pt );
333 
334  MIRROR( m_BezierC1.y, aCentre.y );
335  MIRROR( m_BezierC2.y, aCentre.y );
336 
337  MIRROR( m_Start0.y, 0 );
338  MIRROR( m_End0.y, 0 );
339  MIRROR( m_Bezier0_C1.y, 0 );
340  MIRROR( m_Bezier0_C2.y, 0 );
342  break;
343 
344  case S_POLYGON:
345  // polygon corners coordinates are always relative to the
346  // footprint position, orientation 0
347  for( auto iter = m_Poly.Iterate(); iter; iter++ )
348  {
349  MIRROR( iter->y, 0 );
350  }
351  break;
352  }
353 
354  // DRAWSEGMENT items are not usually on copper layers, but
355  // it can happen in microwave apps.
356  // However, currently, only on Front or Back layers.
357  // So the copper layers count is not taken in account
358  SetLayer( FlipLayer( GetLayer() ) );
359 }
wxPoint m_Bezier0_C2
Bezier Control Point 2, relative to module origin, orient 0.
virtual void SetLayer(PCB_LAYER_ID aLayer)
Function SetLayer sets the layer this item is on.
STROKE_T GetShape() const
SHAPE_POLY_SET m_Poly
Stores the S_POLYGON shape.
polygon (not yet used for tracks, but could be in microwave apps)
PCB_LAYER_ID FlipLayer(PCB_LAYER_ID aLayerId, int aCopperLayersCount)
Function FlippedLayerNumber.
Definition: lset.cpp:475
void RebuildBezierToSegmentsPointsList(int aMinSegLen)
Rebuild the m_BezierPoints vertex list that approximate the Bezier curve by a list of segments Has me...
usual segment : line with rounded ends
ITERATOR Iterate(int aFirst, int aLast, bool aIterateHoles=false)
Function Iterate returns an object to iterate through the points of the polygons between aFirst and a...
const wxPoint & GetEnd() const
Function GetEnd returns the ending point of the graphic.
wxPoint m_End0
End point, relative to module origin, orient 0.
wxPoint m_BezierC1
Bezier Control Point 1.
wxPoint m_Bezier0_C1
Bezier Control Point 1, relative to module origin, orient 0.
void MIRROR(T &aPoint, const T &aMirrorRef)
Definition: macros.h:122
Arcs (with rounded ends)
Bezier Curve.
void SetStart(const wxPoint &aStart)
double GetAngle() const
wxPoint m_BezierC2
Bezier Control Point 2.
void SetEnd(const wxPoint &aEnd)
void SetAngle(double aAngle)
Function SetAngle sets the angle for arcs, and normalizes it within the range 0 - 360 degrees.
const wxPoint & GetStart() const
Function GetStart returns the starting point of the graphic.
int m_Width
thickness of lines ...
wxPoint m_Start0
Start point or center, relative to module origin, orient 0.
virtual PCB_LAYER_ID GetLayer() const
Function GetLayer returns the primary layer this item is on.

References FlipLayer(), DRAWSEGMENT::GetAngle(), DRAWSEGMENT::GetEnd(), BOARD_ITEM::GetLayer(), DRAWSEGMENT::GetShape(), DRAWSEGMENT::GetStart(), SHAPE_POLY_SET::Iterate(), m_Bezier0_C1, m_Bezier0_C2, DRAWSEGMENT::m_BezierC1, DRAWSEGMENT::m_BezierC2, m_End0, DRAWSEGMENT::m_Poly, m_Start0, DRAWSEGMENT::m_Width, MIRROR(), DRAWSEGMENT::RebuildBezierToSegmentsPointsList(), S_ARC, S_CURVE, S_POLYGON, S_SEGMENT, DRAWSEGMENT::SetAngle(), DRAWSEGMENT::SetEnd(), BOARD_ITEM::SetLayer(), and DRAWSEGMENT::SetStart().

◆ Flip() [2/2]

void BOARD_ITEM::Flip ( const VECTOR2I aCentre)
inlineinherited

Definition at line 270 of file class_board_item.h.

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

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

◆ GetAngle()

◆ GetArcAngleStart()

double DRAWSEGMENT::GetArcAngleStart ( ) const
inherited

function GetArcAngleStart()

Returns
the angle of the starting point of this arc, between 0 and 3600 in 0.1 deg

Definition at line 307 of file class_drawsegment.cpp.

308 {
309  // due to the Y axis orient atan2 needs - y value
310  double angleStart = ArcTangente( GetArcStart().y - GetCenter().y,
311  GetArcStart().x - GetCenter().x );
312 
313  // Normalize it to 0 ... 360 deg, to avoid discontinuity for angles near 180 deg
314  // because 180 deg and -180 are very near angles when ampping betewwen -180 ... 180 deg.
315  // and this is not easy to handle in calculations
316  NORMALIZE_ANGLE_POS( angleStart );
317 
318  return angleStart;
319 }
const wxPoint GetCenter() const override
Function GetCenter()
void NORMALIZE_ANGLE_POS(T &Angle)
Definition: trigo.h:250
double ArcTangente(int dy, int dx)
Definition: trigo.cpp:170
const wxPoint & GetArcStart() const

References ArcTangente(), DRAWSEGMENT::GetArcStart(), DRAWSEGMENT::GetCenter(), and NORMALIZE_ANGLE_POS().

Referenced by DRAWSEGMENT::computeArcBBox(), KIGFX::PCB_PAINTER::draw(), and DRAWSEGMENT::HitTest().

◆ GetArcEnd()

const wxPoint DRAWSEGMENT::GetArcEnd ( ) const
inherited

Definition at line 263 of file class_drawsegment.cpp.

264 {
265  wxPoint endPoint( m_End ); // start of arc
266 
267  switch( m_Shape )
268  {
269  case S_ARC:
270  // rotate the starting point of the arc, given by m_End, through the
271  // angle m_Angle to get the ending point of the arc.
272  // m_Start is the arc centre
273  endPoint = m_End; // m_End = start point of arc
274  RotatePoint( &endPoint, m_Start, -m_Angle );
275  break;
276 
277  default:
278  break;
279  }
280 
281  return endPoint; // after rotation, the end of the arc.
282 }
void RotatePoint(int *pX, int *pY, double angle)
Definition: trigo.cpp:216
double m_Angle
Used only for Arcs: Arc angle in 1/10 deg.
wxPoint m_Start
Line start point or Circle and Arc center.
wxPoint m_End
Line end point or circle and arc start point.
Arcs (with rounded ends)
STROKE_T m_Shape
Shape: line, Circle, Arc.

References DRAWSEGMENT::m_Angle, DRAWSEGMENT::m_End, DRAWSEGMENT::m_Shape, DRAWSEGMENT::m_Start, RotatePoint(), and S_ARC.

Referenced by GRID_HELPER::computeAnchors(), ConvertOutlineToPolygon(), findPoint(), EDIT_POINTS_FACTORY::Make(), DIALOG_PAD_PROPERTIES::OnPaintShowPanel(), POINT_EDITOR::updateItem(), and POINT_EDITOR::updatePoints().

◆ GetArcMid()

const wxPoint DRAWSEGMENT::GetArcMid ( ) const
inherited

Definition at line 285 of file class_drawsegment.cpp.

286 {
287  wxPoint endPoint( m_End );
288 
289  switch( m_Shape )
290  {
291  case S_ARC:
292  // rotate the starting point of the arc, given by m_End, through half
293  // the angle m_Angle to get the middle of the arc.
294  // m_Start is the arc centre
295  endPoint = m_End; // m_End = start point of arc
296  RotatePoint( &endPoint, m_Start, -m_Angle / 2.0 );
297  break;
298 
299  default:
300  break;
301  }
302 
303  return endPoint; // after rotation, the end of the arc.
304 }
void RotatePoint(int *pX, int *pY, double angle)
Definition: trigo.cpp:216
double m_Angle
Used only for Arcs: Arc angle in 1/10 deg.
wxPoint m_Start
Line start point or Circle and Arc center.
wxPoint m_End
Line end point or circle and arc start point.
Arcs (with rounded ends)
STROKE_T m_Shape
Shape: line, Circle, Arc.

References DRAWSEGMENT::m_Angle, DRAWSEGMENT::m_End, DRAWSEGMENT::m_Shape, DRAWSEGMENT::m_Start, RotatePoint(), and S_ARC.

Referenced by EDIT_POINTS_FACTORY::Make(), POINT_EDITOR::updateItem(), and POINT_EDITOR::updatePoints().

◆ GetArcStart()

◆ GetBezControl1()

const wxPoint& DRAWSEGMENT::GetBezControl1 ( ) const
inlineinherited

◆ GetBezControl2()

const wxPoint& DRAWSEGMENT::GetBezControl2 ( ) const
inlineinherited

◆ GetBezier0_C1()

const wxPoint& EDGE_MODULE::GetBezier0_C1 ( ) const
inline

Definition at line 100 of file class_edge_mod.h.

100 { return m_Bezier0_C1; }
wxPoint m_Bezier0_C1
Bezier Control Point 1, relative to module origin, orient 0.

References m_Bezier0_C1.

Referenced by PCB_IO::format(), and MoveMarkedItems().

◆ GetBezier0_C2()

const wxPoint& EDGE_MODULE::GetBezier0_C2 ( ) const
inline

Definition at line 103 of file class_edge_mod.h.

103 { return m_Bezier0_C2; }
wxPoint m_Bezier0_C2
Bezier Control Point 2, relative to module origin, orient 0.

References m_Bezier0_C2.

Referenced by PCB_IO::format(), and MoveMarkedItems().

◆ GetBezierPoints()

const std::vector<wxPoint>& DRAWSEGMENT::GetBezierPoints ( ) const
inlineinherited

◆ GetBoard()

BOARD * BOARD_ITEM::GetBoard ( ) const
virtualinherited

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

Definition at line 64 of file class_board_item.cpp.

65 {
66  if( Type() == PCB_T )
67  return (BOARD*) this;
68 
69  BOARD_ITEM* parent = GetParent();
70 
71  if( parent )
72  return parent->GetBoard();
73 
74  return NULL;
75 }
Definition: typeinfo.h:85
Class BOARD_ITEM is a base class for any item which can be embedded within the BOARD container class,...
virtual BOARD * GetBoard() const
Function GetBoard returns the BOARD in which this BOARD_ITEM resides, or NULL if none.
Class BOARD holds information pertinent to a Pcbnew printed circuit board.
Definition: class_board.h:170
BOARD_ITEM_CONTAINER * GetParent() const
KICAD_T Type() const
Function Type()
Definition: base_struct.h:204

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

Referenced by DeleteMarkedItems(), TEXTE_PCB::Draw(), PCB_TARGET::Draw(), ZONE_CONTAINER::Draw(), Draw(), TEXTE_MODULE::Draw(), TRACK::Draw(), DIMENSION::Draw(), DRAWSEGMENT::Draw(), MODULE::Draw(), VIA::Draw(), D_PAD::Draw(), MODULE::DrawAncre(), ZONE_CONTAINER::DrawFilledArea(), TEXTE_PCB::Flip(), TRACK::Flip(), VIA::Flip(), ZONE_CONTAINER::Flip(), BOARD_ITEM::GetBoard(), MODULE::GetBoundingPoly(), BOARD_ITEM::GetLayerName(), PCB_DRAW_PANEL_GAL::GetMsgPanelInfo(), TRACK::GetMsgPanelInfo(), NETINFO_ITEM::GetMsgPanelInfo(), D_PAD::GetMsgPanelInfo(), TRACK::GetMsgPanelInfoBase(), VIA::GetMsgPanelInfoBase(), TRACK::GetMsgPanelInfoBase_Common(), BOARD_CONNECTED_ITEM::GetNetClass(), BOARD_CONNECTED_ITEM::GetNetnameMsg(), VIA::GetSelectMenuText(), D_PAD::GetSelectMenuText(), D_PAD::GetSolderMaskMargin(), D_PAD::GetSolderPasteMargin(), EAGLE_PLUGIN::packageWire(), PushTrack(), BOARD_CONNECTED_ITEM::SetNet(), BOARD_CONNECTED_ITEM::SetNetCode(), MODULE::ViewBBox(), VIA::ViewGetLOD(), and D_PAD::ViewGetLOD().

◆ GetBoundingBox()

const EDA_RECT DRAWSEGMENT::GetBoundingBox ( ) const
overridevirtualinherited

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

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

Reimplemented from EDA_ITEM.

Definition at line 551 of file class_drawsegment.cpp.

552 {
553  EDA_RECT bbox;
554 
555  bbox.SetOrigin( m_Start );
556 
557  switch( m_Shape )
558  {
559  case S_SEGMENT:
560  bbox.SetEnd( m_End );
561  break;
562 
563  case S_CIRCLE:
564  bbox.Inflate( GetRadius() );
565  break;
566 
567  case S_ARC:
568  computeArcBBox( bbox );
569  break;
570 
571  case S_POLYGON:
572  if( m_Poly.IsEmpty() )
573  break;
574  {
575  wxPoint p_end;
576  MODULE* module = GetParentModule();
577  bool first = true;
578 
579  for( auto iter = m_Poly.CIterate(); iter; iter++ )
580  {
581  wxPoint pt ( iter->x, iter->y );
582 
583  if( module ) // Transform, if we belong to a module
584  {
585  RotatePoint( &pt, module->GetOrientation() );
586  pt += module->GetPosition();
587  }
588 
589 
590  if( first )
591  {
592  p_end = pt;
593  bbox.SetX( pt.x );
594  bbox.SetY( pt.y );
595  first = false;
596  }
597  else
598  {
599 
600  bbox.SetX( std::min( bbox.GetX(), pt.x ) );
601  bbox.SetY( std::min( bbox.GetY(), pt.y ) );
602 
603  p_end.x = std::max( p_end.x, pt.x );
604  p_end.y = std::max( p_end.y, pt.y );
605  }
606  }
607 
608  bbox.SetEnd( p_end );
609  break;
610  }
611 
612  case S_CURVE:
613 
614  for( unsigned ii = 0; ii < m_BezierPoints.size(); ++ii )
615  bbox.Merge( m_BezierPoints[ii] );
616  break;
617 
618  default:
619  break;
620  }
621 
622  bbox.Inflate( ((m_Width+1) / 2) + 1 );
623  bbox.Normalize();
624 
625  return bbox;
626 }
double GetOrientation() const
Definition: class_module.h:188
void Merge(const EDA_RECT &aRect)
Function Merge modifies the position and size of the rectangle in order to contain aRect.
int GetX() const
Definition: eda_rect.h:109
SHAPE_POLY_SET m_Poly
Stores the S_POLYGON shape.
polygon (not yet used for tracks, but could be in microwave apps)
bool IsEmpty() const
Returns true if the set is empty (no polygons at all)
void SetOrigin(const wxPoint &pos)
Definition: eda_rect.h:124
usual segment : line with rounded ends
void RotatePoint(int *pX, int *pY, double angle)
Definition: trigo.cpp:216
wxPoint m_Start
Line start point or Circle and Arc center.
void computeArcBBox(EDA_RECT &aBBox) const
wxPoint m_End
Line end point or circle and arc start point.
void SetEnd(int x, int y)
Definition: eda_rect.h:134
Arcs (with rounded ends)
MODULE * GetParentModule() const
Function GetParentModule returns a pointer to the parent module, or NULL if DRAWSEGMENT does not belo...
void SetX(int val)
Definition: eda_rect.h:130
STROKE_T m_Shape
Shape: line, Circle, Arc.
int GetRadius() const
Function GetRadius returns the radius of this item Has meaning only for arc and circle.
Bezier Curve.
CONST_ITERATOR CIterate(int aFirst, int aLast, bool aIterateHoles=false) const
void SetY(int val)
Definition: eda_rect.h:131
void Normalize()
Function Normalize ensures that the height ant width are positive.
#define max(a, b)
Definition: auxiliary.h:86
Class EDA_RECT handles the component boundary box.
Definition: eda_rect.h:44
int GetY() const
Definition: eda_rect.h:110
int m_Width
thickness of lines ...
const wxPoint GetPosition() const override
Definition: class_module.h:183
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
std::vector< wxPoint > m_BezierPoints

References SHAPE_POLY_SET::CIterate(), DRAWSEGMENT::computeArcBBox(), MODULE::GetOrientation(), DRAWSEGMENT::GetParentModule(), MODULE::GetPosition(), DRAWSEGMENT::GetRadius(), EDA_RECT::GetX(), EDA_RECT::GetY(), EDA_RECT::Inflate(), SHAPE_POLY_SET::IsEmpty(), DRAWSEGMENT::m_BezierPoints, DRAWSEGMENT::m_End, DRAWSEGMENT::m_Poly, DRAWSEGMENT::m_Shape, DRAWSEGMENT::m_Start, DRAWSEGMENT::m_Width, max, EDA_RECT::Merge(), min, EDA_RECT::Normalize(), RotatePoint(), S_ARC, S_CIRCLE, S_CURVE, S_POLYGON, S_SEGMENT, EDA_RECT::SetEnd(), EDA_RECT::SetOrigin(), EDA_RECT::SetX(), and EDA_RECT::SetY().

Referenced by CINFO3D_VISU::AddShapeWithClearanceToContainer(), DRAWSEGMENT::GetCenter(), DRAWSEGMENT::HitTest(), and CINFO3D_VISU::transformGraphicModuleEdgeToPolygonSet().

◆ GetCenter()

const wxPoint DRAWSEGMENT::GetCenter ( ) const
overridevirtualinherited

Function GetCenter()

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

Returns
centre point of the item

Reimplemented from BOARD_ITEM.

Definition at line 231 of file class_drawsegment.cpp.

232 {
233  wxPoint c;
234 
235  switch( m_Shape )
236  {
237  case S_ARC:
238  case S_CIRCLE:
239  c = m_Start;
240  break;
241 
242  case S_SEGMENT:
243  // Midpoint of the line
244  c = ( GetStart() + GetEnd() ) / 2;
245  break;
246 
247  case S_POLYGON:
248  case S_RECT:
249  case S_CURVE:
250  c = GetBoundingBox().Centre();
251  break;
252 
253  default:
254  wxASSERT_MSG( false, "DRAWSEGMENT::GetCentre not implemented for shape"
255  + ShowShape( GetShape() ) );
256  break;
257  }
258 
259  return c;
260 }
static wxString ShowShape(STROKE_T aShape)
Function ShowShape converts the enum STROKE_T integer value to a wxString.
STROKE_T GetShape() const
polygon (not yet used for tracks, but could be in microwave apps)
usual segment : line with rounded ends
const wxPoint & GetEnd() const
Function GetEnd returns the ending point of the graphic.
segment with non rounded ends
wxPoint m_Start
Line start point or Circle and Arc center.
Arcs (with rounded ends)
STROKE_T m_Shape
Shape: line, Circle, Arc.
Bezier Curve.
wxPoint Centre() const
Definition: eda_rect.h:60
const wxPoint & GetStart() const
Function GetStart returns the starting point of the graphic.
const EDA_RECT GetBoundingBox() const override
Function GetBoundingBox returns the orthogonal, bounding box of this object for display purposes.

References EDA_RECT::Centre(), DRAWSEGMENT::GetBoundingBox(), DRAWSEGMENT::GetEnd(), DRAWSEGMENT::GetShape(), DRAWSEGMENT::GetStart(), DRAWSEGMENT::m_Shape, DRAWSEGMENT::m_Start, S_ARC, S_CIRCLE, S_CURVE, S_POLYGON, S_RECT, S_SEGMENT, and BOARD_ITEM::ShowShape().

Referenced by CINFO3D_VISU::AddShapeWithClearanceToContainer(), GRID_HELPER::computeAnchors(), ConvertOutlineToPolygon(), export_vrml_drawsegment(), DRAWSEGMENT::GetArcAngleStart(), DRAWSEGMENT::HitTest(), idf_export_outline(), EDIT_POINTS_FACTORY::Make(), DIALOG_PAD_PROPERTIES::OnPaintShowPanel(), EAGLE_PLUGIN::packageRectangle(), PCB_PARSER::parseD_PAD(), DIALOG_PAD_PROPERTIES::redraw(), PNS_KICAD_IFACE::syncGraphicalItem(), DRC::testCopperDrawItem(), DRAWSEGMENT::TransformShapeWithClearanceToPolygon(), POINT_EDITOR::updateItem(), and POINT_EDITOR::updatePoints().

◆ GetClass()

wxString EDGE_MODULE::GetClass ( ) const
inlineoverridevirtual

Function GetClass returns the class name.

Returns
wxString

Reimplemented from DRAWSEGMENT.

Definition at line 126 of file class_edge_mod.h.

127  {
128  return wxT( "MGRAPHIC" );
129  }

◆ GetEditFlags()

STATUS_FLAGS EDA_ITEM::GetEditFlags ( ) const
inlineinherited

Definition at line 263 of file base_struct.h.

264  {
268  return m_Flags & mask;
269  }
#define END_ONPAD
Pcbnew: flag set for track segment ending on a pad.
Definition: base_struct.h:133
#define BEGIN_ONPAD
Pcbnew: flag set for track segment starting on a pad.
Definition: base_struct.h:132
#define EDA_ITEM_ALL_FLAGS
Definition: base_struct.h:148
#define SELECTED
Definition: base_struct.h:121
#define BRIGHTENED
item is drawn with a bright contour
Definition: base_struct.h:137
#define DP_COUPLED
item is coupled with another item making a differential pair
Definition: base_struct.h:139
#define HIGHLIGHTED
item is drawn in normal colors, when the rest is darkened
Definition: base_struct.h:136
#define IS_DANGLING
indicates a pin is dangling
Definition: base_struct.h:143
STATUS_FLAGS m_Flags
Flag bits for editing and other uses.
Definition: base_struct.h:181
#define ENDPOINT
ends. (Used to support dragging.)
Definition: base_struct.h:120
#define STARTPOINT
When a line is selected, these flags indicate which.
Definition: base_struct.h:119

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

Referenced by AbortMoveAndEditTarget(), SCH_EDIT_TOOL::ChangeShape(), EDA_ITEM::ClearEditFlags(), SCH_EDIT_FRAME::ConvertTextType(), 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(), SCH_EDIT_FRAME::DeleteJunction(), PCB_BASE_FRAME::DeleteTextModule(), BOARD::Draw(), PCB_EDIT_FRAME::Edit_TrackSegm_Width(), SCH_EDIT_FRAME::EditComponentFieldText(), SCH_EDIT_FRAME::EditImage(), SCH_EDITOR_CONTROL::EditWithSymbolEditor(), PCB_EDIT_FRAME::FlipTextePcb(), LIB_VIEW_FRAME::GeneralControl(), FOOTPRINT_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(), PCB_EDIT_FRAME::OnLeftClick(), FOOTPRINT_EDIT_FRAME::OnLeftDClick(), PCB_EDIT_FRAME::OnLeftDClick(), EDA_DRAW_PANEL::OnMouseEvent(), FOOTPRINT_EDIT_FRAME::OnRightClick(), GERBVIEW_FRAME::OnRightClick(), PCB_EDIT_FRAME::OnRightClick(), PCB_EDIT_FRAME::PlaceTarget(), FOOTPRINT_EDIT_FRAME::PrepareItemForHotkey(), TRACKS_CLEANER::removeDuplicatesOfTrack(), PCB_BASE_FRAME::Rotate_Module(), PCB_EDIT_FRAME::Rotate_Texte_Pcb(), PCB_BASE_FRAME::RotateTextModule(), SCH_EDIT_FRAME::SchematicCleanUp(), SCH_EDIT_FRAME::SelectUnit(), DIALOG_TEXT_PROPERTIES::TransferDataFromWindow(), DIALOG_EDIT_COMPONENT_IN_SCHEMATIC::TransferDataFromWindow(), DIALOG_TARGET_PROPERTIES::TransferDataFromWindow(), DIALOG_LABEL_EDITOR::TransferDataFromWindow(), and DIALOG_FOOTPRINT_BOARD_EDITOR::TransferDataFromWindow().

◆ GetEnd()

◆ GetEnd0()

const wxPoint& EDGE_MODULE::GetEnd0 ( ) const
inline

Definition at line 97 of file class_edge_mod.h.

97 { return m_End0; }
wxPoint m_End0
End point, relative to module origin, orient 0.

References m_End0.

Referenced by FootprintWriteShape(), PCB_IO::format(), hash_eda(), DSN::SPECCTRA_DB::makeIMAGE(), MoveMarkedItems(), GPCB_FPL_CACHE::parseMODULE(), and ShowNewEdgeModule().

◆ GetFlags()

◆ GetLayer()

virtual PCB_LAYER_ID BOARD_ITEM::GetLayer ( ) const
inlinevirtualinherited

Function GetLayer returns the primary layer this item is on.

Reimplemented in ZONE_CONTAINER.

Definition at line 123 of file class_board_item.h.

123 { return m_Layer; }
PCB_LAYER_ID m_Layer

References BOARD_ITEM::m_Layer.

Referenced by Abort_MoveOrCopyModule(), DIALOG_GLOBAL_DELETION::AcceptPcbDelete(), CN_CONNECTIVITY_ALGO::Add(), CN_LIST::Add(), CINFO3D_VISU::AddGraphicsShapesWithClearanceToContainer(), DIMENSION::AdjustDimensionDetails(), PCB_EDIT_FRAME::Begin_DrawSegment(), FOOTPRINT_EDIT_FRAME::Begin_Edge_Module(), AR_AUTOPLACER::buildFpAreas(), PCB_EDIT_FRAME::Change_Side_Module(), checkConnectedTo(), MODULE::CopyNetlistSettings(), CreateBoardSection(), MWAVE::CreateMicrowaveInductor(), CreateRoutesSection(), DIALOG_GRAPHIC_ITEM_PROPERTIES::DIALOG_GRAPHIC_ITEM_PROPERTIES(), DIALOG_TEXT_PROPERTIES::DIALOG_TEXT_PROPERTIES(), DIALOG_TRACK_VIA_PROPERTIES::DIALOG_TRACK_VIA_PROPERTIES(), PCB_EDIT_FRAME::DoGenFootprintsPositionFile(), DRC::doTrackKeepoutDrc(), TEXTE_MODULE::Draw(), DRAWSEGMENT::Draw(), KIGFX::PCB_PAINTER::draw(), FOOTPRINT_EDIT_FRAME::Edit_Edge_Layer(), FOOTPRINT_EDIT_FRAME::Edit_Edge_Width(), export_vrml_drawsegment(), export_vrml_edge_module(), export_vrml_module(), export_vrml_pcbtext(), export_vrml_text_module(), PCB_EDIT_FRAME::ExportToGenCAD(), TEXTE_PCB::Flip(), PCB_TARGET::Flip(), Flip(), TEXTE_MODULE::Flip(), TRACK::Flip(), DIMENSION::Flip(), MODULE::Flip(), DRAWSEGMENT::Flip(), PCB_IO::FootprintSave(), FootprintWriteShape(), PCB_IO::formatLayer(), DSN::SPECCTRA_DB::FromBOARD(), AR_AUTOPLACER::genModuleOnRoutingMatrix(), BOARD::GetFootprint(), ZONE_CONTAINER::GetLayer(), AR_AUTOPLACER::getOptimalModulePlacement(), BOARD::GetPad(), TEXT_MOD_GRID_TABLE::GetValueAsLong(), BOARD::GetVisibleTrack(), SELECTION_TOOL::guessSelectionCandidates(), idf_export_module(), GENERAL_COLLECTOR::Inspect(), PCB_LAYER_COLLECTOR::Inspect(), D_PAD::IsFlipped(), MODULE::IsFlipped(), IsParentFlipped(), TEXTE_MODULE::IsParentFlipped(), itemIsIncludedByFilter(), FOOTPRINT_EDIT_FRAME::Load_Module_From_BOARD(), BOARD::MarkTrace(), DIALOG_FOOTPRINT_FP_EDITOR::OnAddField(), DIALOG_FOOTPRINT_BOARD_EDITOR::OnAddField(), PCB_EDIT_FRAME::OnRightClick(), EAGLE_PLUGIN::packagePad(), PCB_EDIT_FRAME::PlaceDraggedOrMovedTrackSegment(), BRDITEMS_PLOTTER::Plot_1_EdgeModule(), BRDITEMS_PLOTTER::Plot_Edges_Modules(), BRDITEMS_PLOTTER::PlotAllTextsModule(), BRDITEMS_PLOTTER::PlotDimension(), BRDITEMS_PLOTTER::PlotDrawSegment(), BRDITEMS_PLOTTER::PlotPcbTarget(), BRDITEMS_PLOTTER::PlotTextePcb(), processBoardItem(), DIALOG_GLOBAL_EDIT_TEXT_AND_GRAPHICS::processItem(), processTextItem(), TRACKS_CLEANER::removeDuplicatesOfTrack(), PCB_BASE_FRAME::ResetTextSize(), SELECTION_TOOL::selectable(), TEXT_MOD_GRID_TABLE::SetValueAsLong(), ShowClearance(), PNS_KICAD_IFACE::syncGraphicalItem(), PNS_KICAD_IFACE::syncTrack(), DRC::testCopperDrawItem(), DRC::testCopperTextAndGraphics(), DRC::testCopperTextItem(), DRC::testDisabledLayers(), AR_AUTOPLACER::testModuleOnBoard(), TEXTE_MODULE::TEXTE_MODULE(), AR_MATRIX::TraceSegmentPcb(), TraceSegmentPcb(), TrackListSortByNetcode(), DIALOG_FOOTPRINT_BOARD_EDITOR::TransferDataFromWindow(), DIALOG_TEXT_PROPERTIES::TransferDataToWindow(), DIALOG_GRAPHIC_ITEM_PROPERTIES::TransferDataToWindow(), DIALOG_FOOTPRINT_BOARD_EDITOR::TransferDataToWindow(), CINFO3D_VISU::transformGraphicModuleEdgeToPolygonSet(), MODULE::TransformGraphicShapesWithClearanceToPolygonSet(), MODULE::TransformGraphicTextWithClearanceToPolygonSet(), TEXTE_MODULE::ViewGetLayers(), TRACK::ViewGetLayers(), TEXTE_MODULE::ViewGetLOD(), DIALOG_GLOBAL_EDIT_TRACKS_AND_VIAS::visitItem(), and DIALOG_GLOBAL_EDIT_TEXT_AND_GRAPHICS::visitItem().

◆ GetLayerName()

wxString BOARD_ITEM::GetLayerName ( ) const
inherited

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

Returns
wxString containing the layer name associated with this item.

Definition at line 78 of file class_board_item.cpp.

79 {
80  BOARD* board = GetBoard();
81 
82  if( board )
83  return board->GetLayerName( m_Layer );
84 
85  // If no parent, return standard name
87 }
const wxString GetLayerName(PCB_LAYER_ID aLayer) const
Function GetLayerName returns the name of a layer given by aLayer.
PCB_LAYER_ID m_Layer
virtual BOARD * GetBoard() const
Function GetBoard returns the BOARD in which this BOARD_ITEM resides, or NULL if none.
Class BOARD holds information pertinent to a Pcbnew printed circuit board.
Definition: class_board.h:170
static wxString GetStandardLayerName(PCB_LAYER_ID aLayerId)
Function GetStandardLayerName returns an "English Standard" name of a PCB layer when given aLayerNumb...
Definition: class_board.h:654

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

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

◆ GetLayerSet()

virtual LSET BOARD_ITEM::GetLayerSet ( ) const
inlinevirtualinherited

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

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

Reimplemented in D_PAD, VIA, and ZONE_CONTAINER.

Definition at line 131 of file class_board_item.h.

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

References BOARD_ITEM::m_Layer.

Referenced by GRID_HELPER::BestSnapAnchor(), build_pad_testpoints(), BOARD::chainMarkedSegments(), Collect_TrackSegmentsToDrag(), DRC::doTrackDrc(), DRC::doTrackKeepoutDrc(), DRAWING_TOOL::DrawVia(), PCB_EDIT_FRAME::EraseRedundantTrack(), find_vias_and_tracks_at(), TRACK::GetEndSegments(), TRACK::GetTrack(), hash_board_item(), BOARD::MarkTrace(), POINT_EDITOR::OnSelectionChange(), and PCB_EDIT_FRAME::StartMoveOneNodeOrSegment().

◆ GetLength()

double DRAWSEGMENT::GetLength ( ) const
inherited

Function GetLength returns the length of the track using the hypotenuse calculation.

Returns
double - the length of the track

Definition at line 83 of file class_drawsegment.cpp.

84 {
85  double length = 0.0;
86 
87  switch( m_Shape )
88  {
89  case S_CURVE:
90  for( size_t ii = 1; ii < m_BezierPoints.size(); ++ii )
91  length += GetLineLength( m_BezierPoints[ii - 1], m_BezierPoints[ii] );
92 
93  break;
94 
95  default:
96  length = GetLineLength( GetStart(), GetEnd() );
97  break;
98  }
99 
100  return length;
101 }
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:200
const wxPoint & GetEnd() const
Function GetEnd returns the ending point of the graphic.
STROKE_T m_Shape
Shape: line, Circle, Arc.
Bezier Curve.
const wxPoint & GetStart() const
Function GetStart returns the starting point of the graphic.
std::vector< wxPoint > m_BezierPoints

References DRAWSEGMENT::GetEnd(), GetLineLength(), DRAWSEGMENT::GetStart(), DRAWSEGMENT::m_BezierPoints, DRAWSEGMENT::m_Shape, and S_CURVE.

Referenced by DRAWING_TOOL::drawSegment(), DRAWSEGMENT::GetMsgPanelInfo(), and DRAWSEGMENT::GetSelectMenuText().

◆ GetList()

DHEAD* EDA_ITEM::GetList ( ) const
inlineinherited

◆ GetMenuImage()

BITMAP_DEF EDGE_MODULE::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 DRAWSEGMENT.

Definition at line 302 of file class_edge_mod.cpp.

303 {
304  return show_mod_edge_xpm;
305 }

◆ GetMsgPanelInfo()

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

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

Note
This method replaces DisplayInfo() so that KiCad objects no longer have any knowledge of wxWidgets UI objects.
Parameters
aListis the list to populate.

Reimplemented from DRAWSEGMENT.

Definition at line 271 of file class_edge_mod.cpp.

272 {
273  wxString msg;
274 
275  MODULE* module = (MODULE*) m_Parent;
276 
277  if( !module )
278  return;
279 
280  BOARD* board = (BOARD*) module->GetParent();
281 
282  if( !board )
283  return;
284 
285  aList.push_back( MSG_PANEL_ITEM( _( "Footprint" ), module->GetReference(), DARKCYAN ) );
286 
287  // append the features shared with the base class
288  DRAWSEGMENT::GetMsgPanelInfo( aUnits, aList );
289 }
EDA_ITEM * m_Parent
Linked list: Link (parent struct)
Definition: base_struct.h:174
const wxString GetReference() const
Function GetReference.
Definition: class_module.h:462
Class BOARD holds information pertinent to a Pcbnew printed circuit board.
Definition: class_board.h:170
void GetMsgPanelInfo(EDA_UNITS_T aUnits, std::vector< MSG_PANEL_ITEM > &aList) override
Function GetMsgPanelInfo populates aList of MSG_PANEL_ITEM objects with it's internal state for displ...
Class EDA_MSG_ITEM is used EDA_MSG_PANEL as the item type for displaying messages.
Definition: msgpanel.h:53
BOARD_ITEM_CONTAINER * GetParent() const

References DARKCYAN, DRAWSEGMENT::GetMsgPanelInfo(), BOARD_ITEM::GetParent(), MODULE::GetReference(), and EDA_ITEM::m_Parent.

◆ getNextNumberInSequence()

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

Definition at line 98 of file class_board_item.cpp.

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

Referenced by MODULE::GetNextPadName().

◆ GetParent()

BOARD_ITEM_CONTAINER* BOARD_ITEM::GetParent ( void  ) const
inlineinherited

Definition at line 117 of file class_board_item.h.

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

References EDA_ITEM::m_Parent.

Referenced by Abort_Move_ModuleOutline(), AbortMoveTextModule(), POINT_EDITOR::addCorner(), ALIGN_DISTRIBUTE_TOOL::AlignBottom(), ALIGN_DISTRIBUTE_TOOL::AlignCenterX(), ALIGN_DISTRIBUTE_TOOL::AlignCenterY(), ALIGN_DISTRIBUTE_TOOL::AlignTop(), PCB_EDIT_FRAME::createPopUpMenuForFpTexts(), FOOTPRINT_EDIT_FRAME::Delete_Edge_Module(), BOARD_ITEM::DeleteStructure(), PCB_BASE_FRAME::DeleteTextModule(), ALIGN_DISTRIBUTE_TOOL::doAlignLeft(), ALIGN_DISTRIBUTE_TOOL::doAlignRight(), ALIGN_DISTRIBUTE_TOOL::doDistributeCentersHorizontally(), ALIGN_DISTRIBUTE_TOOL::doDistributeCentersVertically(), ALIGN_DISTRIBUTE_TOOL::doDistributeGapsHorizontally(), ALIGN_DISTRIBUTE_TOOL::doDistributeGapsVertically(), KIGFX::PCB_PAINTER::draw(), TEXTE_MODULE::DrawUmbilical(), PCB_EDIT_FRAME::duplicateItems(), EditToolSelectionFilter(), PCB_IO::format(), FormatProbeItem(), BOARD_ITEM::GetBoard(), LEGACY_ARRAY_CREATOR::getModule(), GetMsgPanelInfo(), GetSelectMenuText(), TEXTE_MODULE::GetSelectMenuText(), TEXTE_MODULE::GetShownText(), SELECTION_TOOL::guessSelectionCandidates(), GENERAL_COLLECTOR::Inspect(), ARRAY_CREATOR::Invoke(), IsParentFlipped(), TEXTE_MODULE::IsParentFlipped(), LEGACY_PLUGIN::loadMODULE_TEXT(), PCB_EDIT_FRAME::moveExact(), FOOTPRINT_EDIT_FRAME::OnRightClick(), FOOTPRINT_EDIT_FRAME::Place_EdgeMod(), PCB_BASE_FRAME::PlaceTexteModule(), BRDITEMS_PLOTTER::Plot_1_EdgeModule(), BRDITEMS_PLOTTER::PlotTextModule(), PCB_EDIT_FRAME::Process_Special_Functions(), BOARD_COMMIT::Push(), PCB_BASE_FRAME::ResetTextSize(), PCB_BASE_FRAME::RotateTextModule(), PCB_BASE_EDIT_FRAME::SaveCopyInUndoList(), SELECTION_TOOL::select(), ShowCurrentOutlineWhileMoving(), ShowNewEdgeModule(), PCB_BASE_FRAME::StartMoveTexteModule(), SwapItemData(), DRC::testCopperDrawItem(), DIALOG_TEXT_PROPERTIES::TransferDataToWindow(), and DIALOG_GLOBAL_EDIT_TEXT_AND_GRAPHICS::visitItem().

◆ GetParentModule()

MODULE * DRAWSEGMENT::GetParentModule ( ) const
inherited

Function GetParentModule returns a pointer to the parent module, or NULL if DRAWSEGMENT does not belong to a module.

Returns
MODULE* - pointer to the parent module or NULL.

Definition at line 329 of file class_drawsegment.cpp.

330 {
331  if( !m_Parent || m_Parent->Type() != PCB_MODULE_T )
332  return NULL;
333 
334  return (MODULE*) m_Parent;
335 }
EDA_ITEM * m_Parent
Linked list: Link (parent struct)
Definition: base_struct.h:174
class MODULE, a footprint
Definition: typeinfo.h:89
KICAD_T Type() const
Function Type()
Definition: base_struct.h:204

References EDA_ITEM::m_Parent, PCB_MODULE_T, and EDA_ITEM::Type().

Referenced by ConvertOutlineToPolygon(), KIGFX::PCB_PAINTER::draw(), DRAWSEGMENT::GetBoundingBox(), BRDITEMS_PLOTTER::Plot_1_EdgeModule(), and DRAWSEGMENT::TransformShapeWithClearanceToPolygon().

◆ GetPointCount()

int DRAWSEGMENT::GetPointCount ( ) const
inherited
Returns
the number of corners of the polygonal shape

Definition at line 1009 of file class_drawsegment.cpp.

1010 {
1011  // return the number of corners of the polygonal shape
1012  // this shape is expected to be only one polygon without hole
1013  if( GetPolyShape().OutlineCount() )
1014  return GetPolyShape().VertexCount( 0 );
1015 
1016  return 0;
1017 }
int VertexCount(int aOutline=-1, int aHole=-1) const
Returns the number of vertices in a given outline/hole
SHAPE_POLY_SET & GetPolyShape()

References DRAWSEGMENT::GetPolyShape(), and SHAPE_POLY_SET::VertexCount().

◆ GetPolyShape() [1/2]

◆ GetPolyShape() [2/2]

const SHAPE_POLY_SET& DRAWSEGMENT::GetPolyShape ( ) const
inlineinherited

Definition at line 188 of file class_drawsegment.h.

188 { return m_Poly; }
SHAPE_POLY_SET m_Poly
Stores the S_POLYGON shape.

References DRAWSEGMENT::m_Poly.

◆ GetPosition()

const wxPoint DRAWSEGMENT::GetPosition ( ) const
overridevirtualinherited

Implements BOARD_ITEM.

Definition at line 74 of file class_drawsegment.cpp.

75 {
76  if( m_Shape == S_POLYGON )
77  return (wxPoint) m_Poly.CVertex( 0 );
78  else
79  return m_Start;
80 }
const VECTOR2I & CVertex(int aIndex, int aOutline, int aHole) const
Returns the index-th vertex in a given hole outline within a given outline
SHAPE_POLY_SET m_Poly
Stores the S_POLYGON shape.
polygon (not yet used for tracks, but could be in microwave apps)
wxPoint m_Start
Line start point or Circle and Arc center.
STROKE_T m_Shape
Shape: line, Circle, Arc.

References SHAPE_POLY_SET::CVertex(), DRAWSEGMENT::m_Poly, DRAWSEGMENT::m_Shape, DRAWSEGMENT::m_Start, and S_POLYGON.

Referenced by ConvertOutlineToPolygon().

◆ GetRadius()

int DRAWSEGMENT::GetRadius ( ) const
inlineinherited

Function GetRadius returns the radius of this item Has meaning only for arc and circle.

Definition at line 147 of file class_drawsegment.h.

148  {
149  double radius = GetLineLength( m_Start, m_End );
150  return KiROUND( radius );
151  }
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:200
static int KiROUND(double v)
Round a floating point number to an integer using "round halfway cases away from zero".
Definition: common.h:118
wxPoint m_Start
Line start point or Circle and Arc center.
wxPoint m_End
Line end point or circle and arc start point.

References GetLineLength(), KiROUND(), DRAWSEGMENT::m_End, and DRAWSEGMENT::m_Start.

Referenced by CINFO3D_VISU::AddShapeWithClearanceToContainer(), DRAWSEGMENT::computeArcBBox(), ConvertOutlineToPolygon(), KIGFX::PCB_PAINTER::draw(), DRAWSEGMENT::GetBoundingBox(), hash_eda(), DRAWSEGMENT::HitTest(), idf_export_outline(), PCB_PARSER::parseD_PAD(), DIALOG_GRAPHIC_ITEM_PROPERTIES::TransferDataToWindow(), and DRAWSEGMENT::TransformShapeWithClearanceToPolygon().

◆ GetSelectMenuText()

wxString EDGE_MODULE::GetSelectMenuText ( EDA_UNITS_T  aUnits) const
overridevirtual

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

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

Returns
The menu text string.

Reimplemented from DRAWSEGMENT.

Definition at line 293 of file class_edge_mod.cpp.

294 {
295  return wxString::Format( _( "Graphic %s of %s on %s" ),
296  ShowShape( m_Shape ),
297  ((MODULE*) GetParent())->GetReference(),
298  GetLayerName() );
299 }
static wxString ShowShape(STROKE_T aShape)
Function ShowShape converts the enum STROKE_T integer value to a wxString.
STROKE_T m_Shape
Shape: line, Circle, Arc.
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
BOARD_ITEM_CONTAINER * GetParent() const
wxString GetLayerName() const
Function GetLayerName returns the name of the PCB layer on which the item resides.

References Format(), BOARD_ITEM::GetLayerName(), BOARD_ITEM::GetParent(), DRAWSEGMENT::m_Shape, and BOARD_ITEM::ShowShape().

◆ GetShape()

◆ GetStart()

const wxPoint& DRAWSEGMENT::GetStart ( ) const
inlineinherited

◆ GetStart0()

const wxPoint& EDGE_MODULE::GetStart0 ( ) const
inline

Definition at line 94 of file class_edge_mod.h.

94 { return m_Start0; }
wxPoint m_Start0
Start point or center, relative to module origin, orient 0.

References m_Start0.

Referenced by FOOTPRINT_EDIT_FRAME::Begin_Edge_Module(), FootprintWriteShape(), PCB_IO::format(), hash_eda(), DSN::SPECCTRA_DB::makeIMAGE(), and MoveMarkedItems().

◆ GetState()

◆ GetStatus()

STATUS_FLAGS EDA_ITEM::GetStatus ( ) const
inlineinherited

Definition at line 256 of file base_struct.h.

256 { return m_Status; }
STATUS_FLAGS m_Status
Definition: base_struct.h:167

References EDA_ITEM::m_Status.

Referenced by PCB_IO::format().

◆ GetTimeStamp()

◆ GetType()

int DRAWSEGMENT::GetType ( ) const
inlineinherited

Definition at line 95 of file class_drawsegment.h.

95 { return m_Type; }
int m_Type
Used in complex associations ( Dimensions.. )

References DRAWSEGMENT::m_Type.

Referenced by PCB_EDIT_FRAME::Begin_DrawSegment(), and hash_eda().

◆ GetWidth()

◆ HitTest() [1/2]

bool DRAWSEGMENT::HitTest ( const wxPoint &  aPosition,
int  aAccuracy = 0 
) const
overridevirtualinherited

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

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

Reimplemented from EDA_ITEM.

Definition at line 629 of file class_drawsegment.cpp.

630 {
631  int maxdist = aAccuracy + ( m_Width / 2 );
632 
633  switch( m_Shape )
634  {
635  case S_CIRCLE:
636  case S_ARC:
637  {
638  wxPoint relPos = aPosition - GetCenter();
639  int radius = GetRadius();
640  int dist = KiROUND( EuclideanNorm( relPos ) );
641 
642  if( abs( radius - dist ) <= maxdist )
643  {
644  if( m_Shape == S_CIRCLE )
645  return true;
646 
647  // For arcs, the test point angle must be >= arc angle start
648  // and <= arc angle end
649  // However angle values > 360 deg are not easy to handle
650  // so we calculate the relative angle between arc start point and teast point
651  // this relative arc should be < arc angle if arc angle > 0 (CW arc)
652  // and > arc angle if arc angle < 0 (CCW arc)
653  double arc_angle_start = GetArcAngleStart(); // Always 0.0 ... 360 deg, in 0.1 deg
654 
655  double arc_hittest = ArcTangente( relPos.y, relPos.x );
656 
657  // Calculate relative angle between the starting point of the arc, and the test point
658  arc_hittest -= arc_angle_start;
659 
660  // Normalise arc_hittest between 0 ... 360 deg
661  NORMALIZE_ANGLE_POS( arc_hittest );
662 
663  // Check angle: inside the arc angle when it is > 0
664  // and outside the not drawn arc when it is < 0
665  if( GetAngle() >= 0.0 )
666  {
667  if( arc_hittest <= GetAngle() )
668  return true;
669  }
670  else
671  {
672  if( arc_hittest >= (3600.0 + GetAngle()) )
673  return true;
674  }
675  }
676  }
677  break;
678 
679  case S_CURVE:
680  ((DRAWSEGMENT*)this)->RebuildBezierToSegmentsPointsList( m_Width );
681 
682  for( unsigned int i= 1; i < m_BezierPoints.size(); i++)
683  {
684  if( TestSegmentHit( aPosition, m_BezierPoints[i-1], m_BezierPoints[i-1], maxdist ) )
685  return true;
686  }
687  break;
688 
689  case S_SEGMENT:
690  if( TestSegmentHit( aPosition, m_Start, m_End, maxdist ) )
691  return true;
692  break;
693 
694  case S_POLYGON:
695  {
696  if( !IsPolygonFilled() )
697  {
699  auto poly = m_Poly; //todo: Fix CollideEdge to be const
700  return poly.CollideEdge( VECTOR2I( aPosition ), i,
701  std::max( maxdist, Millimeter2iu( 0.25 ) ) );
702  }
703  else
704  return m_Poly.Collide( VECTOR2I( aPosition ), maxdist );
705  }
706  break;
707 
708  default:
709  wxASSERT_MSG( 0, wxString::Format( "unknown DRAWSEGMENT shape: %d", m_Shape ) );
710  break;
711  }
712 
713  return false;
714 }
double EuclideanNorm(const wxPoint &vector)
Euclidean norm of a 2D vector.
Definition: trigo.h:121
static const int dist[10][10]
Definition: ar_matrix.cpp:320
static int KiROUND(double v)
Round a floating point number to an integer using "round halfway cases away from zero".
Definition: common.h:118
bool CollideEdge(const VECTOR2I &aPoint, VERTEX_INDEX &aClosestVertex, int aClearance=0)
Function CollideEdge Checks whether aPoint collides with any edge of any of the contours of the polyg...
const wxPoint GetCenter() const override
Function GetCenter()
SHAPE_POLY_SET m_Poly
Stores the S_POLYGON shape.
polygon (not yet used for tracks, but could be in microwave apps)
double GetArcAngleStart() const
function GetArcAngleStart()
Struct VERTEX_INDEX.
usual segment : line with rounded ends
void NORMALIZE_ANGLE_POS(T &Angle)
Definition: trigo.h:250
VECTOR2< int > VECTOR2I
Definition: vector2d.h:587
#define abs(a)
Definition: auxiliary.h:84
wxPoint m_Start
Line start point or Circle and Arc center.
double ArcTangente(int dy, int dx)
Definition: trigo.cpp:170
wxPoint m_End
Line end point or circle and arc start point.
Arcs (with rounded ends)
STROKE_T m_Shape
Shape: line, Circle, Arc.
bool Collide(const VECTOR2I &aP, int aClearance=0) const override
Function Collide Checks whether the point aP collides with the inside of the polygon set; if the poin...
int GetRadius() const
Function GetRadius returns the radius of this item Has meaning only for arc and circle.
Bezier Curve.
double GetAngle() const
void Format(OUTPUTFORMATTER *out, int aNestLevel, int aCtl, CPTREE &aTree)
Function Format outputs a PTREE into s-expression format via an OUTPUTFORMATTER derivative.
Definition: ptree.cpp:205
#define max(a, b)
Definition: auxiliary.h:86
size_t i
Definition: json11.cpp:597
int m_Width
thickness of lines ...
bool TestSegmentHit(const wxPoint &aRefPoint, wxPoint aStart, wxPoint aEnd, int aDist)
Function TestSegmentHit test for hit on line segment i.e.
Definition: trigo.cpp:122
bool IsPolygonFilled() const
Polygonal shape is not always filled.
std::vector< wxPoint > m_BezierPoints

References abs, ArcTangente(), SHAPE_POLY_SET::Collide(), SHAPE_POLY_SET::CollideEdge(), dist, EuclideanNorm(), Format(), DRAWSEGMENT::GetAngle(), DRAWSEGMENT::GetArcAngleStart(), DRAWSEGMENT::GetCenter(), DRAWSEGMENT::GetRadius(), i, DRAWSEGMENT::IsPolygonFilled(), KiROUND(), DRAWSEGMENT::m_BezierPoints, DRAWSEGMENT::m_End, DRAWSEGMENT::m_Poly, DRAWSEGMENT::m_Shape, DRAWSEGMENT::m_Start, DRAWSEGMENT::m_Width, max, NORMALIZE_ANGLE_POS(), S_ARC, S_CIRCLE, S_CURVE, S_POLYGON, S_SEGMENT, and TestSegmentHit().

◆ HitTest() [2/2]

bool DRAWSEGMENT::HitTest ( const EDA_RECT aRect,
bool  aContained,
int  aAccuracy = 0 
) const
overridevirtualinherited

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

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

Reimplemented from EDA_ITEM.

Definition at line 717 of file class_drawsegment.cpp.

718 {
719  EDA_RECT arect = aRect;
720  arect.Normalize();
721  arect.Inflate( aAccuracy );
722 
723  EDA_RECT arcRect;
724  EDA_RECT bb = GetBoundingBox();
725 
726  switch( m_Shape )
727  {
728  case S_CIRCLE:
729  // Test if area intersects or contains the circle:
730  if( aContained )
731  return arect.Contains( bb );
732  else
733  {
734  // If the rectangle does not intersect the bounding box, this is a much quicker test
735  if( !aRect.Intersects( bb ) )
736  {
737  return false;
738  }
739  else
740  {
741  return arect.IntersectsCircleEdge( GetCenter(), GetRadius(), GetWidth() );
742  }
743  }
744  break;
745 
746  case S_ARC:
747  // Test for full containment of this arc in the rect
748  if( aContained )
749  {
750  return arect.Contains( bb );
751  }
752  // Test if the rect crosses the arc
753  else
754  {
755  arcRect = bb.Common( arect );
756 
757  /* All following tests must pass:
758  * 1. Rectangle must intersect arc BoundingBox
759  * 2. Rectangle must cross the outside of the arc
760  */
761  return arcRect.Intersects( arect ) &&
763  }
764  break;
765 
766  case S_SEGMENT:
767  if( aContained )
768  {
769  return arect.Contains( GetStart() ) && aRect.Contains( GetEnd() );
770  }
771  else
772  {
773  // Account for the width of the line
774  arect.Inflate( GetWidth() / 2 );
775  return arect.Intersects( GetStart(), GetEnd() );
776  }
777 
778  break;
779 
780  case S_POLYGON:
781  if( aContained )
782  {
783  return arect.Contains( bb );
784  }
785  else
786  {
787  // Fast test: if aRect is outside the polygon bounding box,
788  // rectangles cannot intersect
789  if( !arect.Intersects( bb ) )
790  return false;
791 
792  // Account for the width of the line
793  arect.Inflate( GetWidth() / 2 );
794  int count = m_Poly.TotalVertices();
795 
796  for( int ii = 0; ii < count; ii++ )
797  {
798  auto vertex = m_Poly.CVertex( ii );
799  auto vertexNext = m_Poly.CVertex( ( ii + 1 ) % count );
800 
801  // Test if the point is within aRect
802  if( arect.Contains( ( wxPoint ) vertex ) )
803  return true;
804 
805  // Test if this edge intersects aRect
806  if( arect.Intersects( ( wxPoint ) vertex, ( wxPoint ) vertexNext ) )
807  return true;
808  }
809  }
810  break;
811 
812  case S_CURVE: // not yet handled
813  if( aContained )
814  {
815  return arect.Contains( bb );
816  }
817  else
818  {
819  // Fast test: if aRect is outside the polygon bounding box,
820  // rectangles cannot intersect
821  if( !arect.Intersects( bb ) )
822  return false;
823 
824  // Account for the width of the line
825  arect.Inflate( GetWidth() / 2 );
826  unsigned count = m_BezierPoints.size();
827 
828  for( unsigned ii = 1; ii < count; ii++ )
829  {
830  wxPoint vertex = m_BezierPoints[ii-1];
831  wxPoint vertexNext = m_BezierPoints[ii];
832 
833  // Test if the point is within aRect
834  if( arect.Contains( ( wxPoint ) vertex ) )
835  return true;
836 
837  // Test if this edge intersects aRect
838  if( arect.Intersects( vertex, vertexNext ) )
839  return true;
840  }
841  }
842  break;
843 
844 
845  default:
846  wxASSERT_MSG( 0, wxString::Format( "unknown DRAWSEGMENT shape: %d", m_Shape ) );
847  break;
848  }
849 
850  return false;
851 }
int TotalVertices() const
Returns total number of vertices stored in the set.
const wxPoint GetCenter() const override
Function GetCenter()
const VECTOR2I & CVertex(int aIndex, int aOutline, int aHole) const
Returns the index-th vertex in a given hole outline within a given outline
SHAPE_POLY_SET m_Poly
Stores the S_POLYGON shape.
polygon (not yet used for tracks, but could be in microwave apps)
bool IntersectsCircleEdge(const wxPoint &aCenter, const int aRadius, const int aWidth) const
IntersectsCircleEdge Tests for intersection between this rect and the edge (radius) of a circle.
EDA_RECT Common(const EDA_RECT &aRect) const
Function Common returns the area that is common with another rectangle.
usual segment : line with rounded ends
const wxPoint & GetEnd() const
Function GetEnd returns the ending point of the graphic.
bool Contains(const wxPoint &aPoint) const
Function Contains.
Arcs (with rounded ends)
STROKE_T m_Shape
Shape: line, Circle, Arc.
int GetRadius() const
Function GetRadius returns the radius of this item Has meaning only for arc and circle.
Bezier Curve.
int GetWidth() const
void Normalize()
Function Normalize ensures that the height ant width are positive.
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
Class EDA_RECT handles the component boundary box.
Definition: eda_rect.h:44
bool Intersects(const EDA_RECT &aRect) const
Function Intersects tests for a common area between rectangles.
const wxPoint & GetStart() const
Function GetStart returns the starting point of the graphic.
EDA_RECT & Inflate(wxCoord dx, wxCoord dy)
Function Inflate inflates the rectangle horizontally by dx and vertically by dy.
std::vector< wxPoint > m_BezierPoints
const EDA_RECT GetBoundingBox() const override
Function GetBoundingBox returns the orthogonal, bounding box of this object for display purposes.

References EDA_RECT::Common(), EDA_RECT::Contains(), SHAPE_POLY_SET::CVertex(), Format(), DRAWSEGMENT::GetBoundingBox(), DRAWSEGMENT::GetCenter(), DRAWSEGMENT::GetEnd(), DRAWSEGMENT::GetRadius(), DRAWSEGMENT::GetStart(), DRAWSEGMENT::GetWidth(), EDA_RECT::Inflate(), EDA_RECT::Intersects(), EDA_RECT::IntersectsCircleEdge(), DRAWSEGMENT::m_BezierPoints, DRAWSEGMENT::m_Poly, DRAWSEGMENT::m_Shape, EDA_RECT::Normalize(), S_ARC, S_CIRCLE, S_CURVE, S_POLYGON, S_SEGMENT, and SHAPE_POLY_SET::TotalVertices().

◆ IsBrightened()

bool EDA_ITEM::IsBrightened ( ) const
inlineinherited

Definition at line 230 of file base_struct.h.

230 { return m_Flags & BRIGHTENED; }
#define BRIGHTENED
item is drawn with a bright contour
Definition: base_struct.h:137
STATUS_FLAGS m_Flags
Flag bits for editing and other uses.
Definition: base_struct.h:181

References BRIGHTENED, and EDA_ITEM::m_Flags.

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

◆ IsConnected()

virtual bool BOARD_ITEM::IsConnected ( ) const
inlinevirtualinherited

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

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

Reimplemented in BOARD_CONNECTED_ITEM.

Definition at line 105 of file class_board_item.h.

106  {
107  return false;
108  }

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

◆ IsDragging()

bool EDA_ITEM::IsDragging ( ) const
inlineinherited

◆ IsHighlighted()

bool EDA_ITEM::IsHighlighted ( ) const
inlineinherited

Definition at line 229 of file base_struct.h.

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

References HIGHLIGHTED, and EDA_ITEM::m_Flags.

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

◆ IsLocked()

virtual bool BOARD_ITEM::IsLocked ( ) const
inlinevirtualinherited

Function IsLocked.

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

Reimplemented in MODULE, and TRACK.

Definition at line 193 of file class_board_item.h.

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

Referenced by DIALOG_GLOBAL_DELETION::AcceptPcbDelete(), EditToolSelectionFilter(), GENERAL_COLLECTOR::Inspect(), and PCB_EDIT_FRAME::OnHotkeyDeleteItem().

◆ IsModified()

bool EDA_ITEM::IsModified ( ) const
inlineinherited

Definition at line 223 of file base_struct.h.

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

References IS_CHANGED, and EDA_ITEM::m_Flags.

Referenced by PCB_EDIT_FRAME::OpenProjectFiles().

◆ IsMoving()

◆ IsNew()

bool EDA_ITEM::IsNew ( ) const
inlineinherited

Definition at line 222 of file base_struct.h.

222 { return m_Flags & IS_NEW; }
#define IS_NEW
New item, just created.
Definition: base_struct.h:114
STATUS_FLAGS m_Flags
Flag bits for editing and other uses.
Definition: base_struct.h:181

References IS_NEW, and EDA_ITEM::m_Flags.

Referenced by Abort_Edit_Pcb_Text(), Abort_EditEdge(), Abort_Move_ModuleOutline(), Abort_MoveOrCopyModule(), Abort_Zone_Create_Outline(), AbortBuildDimension(), AbortMoveAndEditTarget(), SCH_EDIT_FRAME::AddItemToScreenAndUndoList(), SCH_EDIT_TOOL::AutoplaceFields(), LIB_CIRCLE::CalcEdit(), LIB_RECTANGLE::CalcEdit(), LIB_FIELD::CalcEdit(), LIB_POLYLINE::CalcEdit(), LIB_ARC::CalcEdit(), LIB_TEXT::CalcEdit(), LIB_POLYLINE::ContinueEdit(), LIB_ARC::ContinueEdit(), SCH_EDIT_TOOL::ConvertDeMorgan(), SCH_EDIT_FRAME::ConvertTextType(), PCB_EDIT_FRAME::Delete_Segment(), PCB_EDIT_FRAME::Delete_Segment_Edge(), LIB_ARC::drawGraphic(), LIB_EDIT_TOOL::Duplicate(), SCH_EDIT_TOOL::Duplicate(), LIB_PIN::EnableEditMode(), LIB_DRAWING_TOOLS::Init(), isNewSegment(), SCH_MOVE_TOOL::Main(), LIB_MOVE_TOOL::Main(), EDIT_TOOL::MoveExact(), FOOTPRINT_EDIT_FRAME::OnLeftClick(), PCB_EDIT_FRAME::OnLeftClick(), FOOTPRINT_EDIT_FRAME::OnLeftDClick(), PCB_EDIT_FRAME::OnLeftDClick(), PCB_EDIT_FRAME::Place_Texte_Pcb(), PCB_BASE_FRAME::PlaceModule(), LIB_PIN_TOOL::PlacePin(), PCB_EDIT_FRAME::PlaceTarget(), ShowClearance(), PCB_EDIT_FRAME::StartMoveTextePcb(), PCB_EDIT_FRAME::SwitchLayer(), DIALOG_SCH_EDIT_SHEET_PIN::TransferDataFromWindow(), and DIALOG_LABEL_EDITOR::TransferDataFromWindow().

◆ IsOnLayer()

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

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

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

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

Reimplemented in D_PAD, VIA, ZONE_CONTAINER, and MARKER_PCB.

Definition at line 173 of file class_board_item.h.

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

References BOARD_ITEM::m_Layer.

Referenced by CINFO3D_VISU::createLayers(), TEXTE_PCB::Draw(), Draw(), TEXTE_MODULE::Draw(), TRACK::Draw(), DRAWSEGMENT::Draw(), TRACK::DrawShortNetname(), GENERAL_COLLECTOR::Inspect(), ZONE_CONTAINER::IsOnLayer(), AR_MATRIX::TraceSegmentPcb(), and TraceSegmentPcb().

◆ IsParentFlipped()

bool EDGE_MODULE::IsParentFlipped ( ) const

Definition at line 361 of file class_edge_mod.cpp.

362 {
363  if( GetParent() && GetParent()->GetLayer() == B_Cu )
364  return true;
365  return false;
366 }
BOARD_ITEM_CONTAINER * GetParent() const
virtual PCB_LAYER_ID GetLayer() const
Function GetLayer returns the primary layer this item is on.

References B_Cu, BOARD_ITEM::GetLayer(), and BOARD_ITEM::GetParent().

Referenced by ViewGetLOD().

◆ IsPolygonFilled()

bool DRAWSEGMENT::IsPolygonFilled ( ) const
inlineinherited

◆ IsPolyShapeValid()

bool DRAWSEGMENT::IsPolyShapeValid ( ) const
inherited
Returns
true if the polygonal shape is valid (has more than 2 points)

Definition at line 997 of file class_drawsegment.cpp.

998 {
999  // return true if the polygonal shape is valid (has more than 2 points)
1000  if( GetPolyShape().OutlineCount() == 0 )
1001  return false;
1002 
1003  const SHAPE_LINE_CHAIN& outline = ((SHAPE_POLY_SET&)GetPolyShape()).Outline( 0 );
1004 
1005  return outline.PointCount() > 2;
1006 }
int PointCount() const
Function PointCount()
Class SHAPE_POLY_SET.
SHAPE_POLY_SET & GetPolyShape()
Class SHAPE_LINE_CHAIN.

References DRAWSEGMENT::GetPolyShape(), and SHAPE_LINE_CHAIN::PointCount().

Referenced by export_vrml_polygon(), PCB_IO::format(), BRDITEMS_PLOTTER::Plot_1_EdgeModule(), and DRAWSEGMENT::TransformShapeWithClearanceToPolygon().

◆ IsReplaceable()

virtual bool EDA_ITEM::IsReplaceable ( ) const
inlinevirtualinherited

Function IsReplaceable.

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

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

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

Definition at line 502 of file base_struct.h.

502 { return false; }

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

◆ IsResized()

bool EDA_ITEM::IsResized ( ) const
inlineinherited

Definition at line 228 of file base_struct.h.

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

References IS_RESIZED, and EDA_ITEM::m_Flags.

Referenced by LIB_POLYLINE::CalcEdit(), and KIGFX::SCH_PAINTER::setColors().

◆ IsSelected()

◆ IsTrack()

bool BOARD_ITEM::IsTrack ( ) const
inlineinherited

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

form of testing.

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

Definition at line 184 of file class_board_item.h.

185  {
186  return ( Type() == PCB_TRACE_T ) || ( Type() == PCB_VIA_T );
187  }
class TRACK, a track segment (segment on a copper layer)
Definition: typeinfo.h:95
class VIA, a via (like a track segment on a copper layer)
Definition: typeinfo.h:96
KICAD_T Type() const
Function Type()
Definition: base_struct.h:204

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

Referenced by PCB_EDIT_FRAME::OnHotKey(), and PCB_EDIT_FRAME::OnHotkeyDeleteItem().

◆ IsType()

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

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

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

Reimplemented in SCH_FIELD, and SCH_LINE.

Definition at line 287 of file base_struct.h.

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

References EOT, EDA_ITEM::m_StructType, and SCH_LOCATE_ANY_T.

Referenced by SCH_SCREEN::GetItem(), SCH_WIRE_BUS_TOOL::IsDrawingBus(), SCH_WIRE_BUS_TOOL::IsDrawingLine(), SCH_WIRE_BUS_TOOL::IsDrawingWire(), SCH_LINE::IsType(), SCH_FIELD::IsType(), EE_POINT_EDITOR::Main(), EE_SELECTION_TOOL::RequestSelection(), and EDA_ITEM::Visit().

◆ IsWireImage()

bool EDA_ITEM::IsWireImage ( ) const
inlineinherited

Definition at line 226 of file base_struct.h.

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

References IS_WIRE_IMAGE, and EDA_ITEM::m_Flags.

◆ IterateForward()

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

134 {
135  EDA_ITEM* p = listStart;
136 
137  for( ; p; p = p->Pnext )
138  {
139  if( SEARCH_QUIT == p->Visit( inspector, testData, scanTypes ) )
140  return SEARCH_QUIT;
141  }
142 
143  return SEARCH_CONTINUE;
144 }
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:157
EDA_ITEM * Pnext
next in linked list
Definition: base_struct.h:170

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

Referenced by EE_COLLECTOR::Collect(), SCH_FIND_COLLECTOR::Collect(), EE_TYPE_COLLECTOR::Collect(), SCH_FIND_COLLECTOR::GetItem(), EE_SELECTION_TOOL::RebuildSelection(), GERBER_FILE_IMAGE::Visit(), MODULE::Visit(), and BOARD::Visit().

◆ Matches() [1/2]

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_COMPONENT, SCH_SHEET, SCH_FIELD, SCH_SHEET_PIN, SCH_TEXT, LIB_PIN, and SCH_MARKER.

Definition at line 458 of file base_struct.h.

459  {
460  return false;
461  }

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

◆ Matches() [2/2]

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

Function Matches compares aText against search criteria in aSearchData.

This is a helper function for simplify derived class logic.

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

Definition at line 174 of file base_struct.cpp.

175 {
176  wxString text = aText;
177  wxString searchText = aSearchData.GetFindString();
178 
179  // Don't match if searching for replaceable item and the item doesn't support text replace.
180  if( (aSearchData.GetFlags() & FR_SEARCH_REPLACE) && !IsReplaceable() )
181  return false;
182 
183  if( aSearchData.GetFlags() & wxFR_WHOLEWORD )
184  return aText.IsSameAs( searchText, aSearchData.GetFlags() & wxFR_MATCHCASE );
185 
186  if( aSearchData.GetFlags() & FR_MATCH_WILDCARD )
187  {
188  if( aSearchData.GetFlags() & wxFR_MATCHCASE )
189  return text.Matches( searchText );
190 
191  return text.MakeUpper().Matches( searchText.MakeUpper() );
192  }
193 
194  if( aSearchData.GetFlags() & wxFR_MATCHCASE )
195  return aText.Find( searchText ) != wxNOT_FOUND;
196 
197  return text.MakeUpper().Find( searchText.MakeUpper() ) != wxNOT_FOUND;
198 }
Perform search using simple wild card matching (* & ?).
Perform a search for a item that has replaceable text.
virtual bool IsReplaceable() const
Function IsReplaceable.
Definition: base_struct.h:502

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

◆ Mirror()

void EDGE_MODULE::Mirror ( const wxPoint  aCentre,
bool  aMirrorAroundXAxis 
)

Mirror an edge of the footprint.

Do not change the layer This is a footprint shape modification. (should be only called by a footprint editing function)

Definition at line 368 of file class_edge_mod.cpp.

369 {
370  // Mirror an edge of the footprint. the layer is not modified
371  // This is a footprint shape modification.
372  switch( GetShape() )
373  {
374  case S_ARC:
375  SetAngle( -GetAngle() );
376  //Fall through
377  default:
378  case S_CURVE:
379  case S_SEGMENT:
380  if( aMirrorAroundXAxis )
381  {
382  MIRROR( m_Start0.y, aCentre.y );
383  MIRROR( m_End0.y, aCentre.y );
384  MIRROR( m_Bezier0_C1.y, aCentre.y );
385  MIRROR( m_Bezier0_C2.y, aCentre.y );
386  }
387  else
388  {
389  MIRROR( m_Start0.x, aCentre.x );
390  MIRROR( m_End0.x, aCentre.x );
391  MIRROR( m_Bezier0_C1.x, aCentre.x );
392  MIRROR( m_Bezier0_C2.x, aCentre.x );
393  }
394 
395  for( unsigned ii = 0; ii < m_BezierPoints.size(); ii++ )
396  {
397  if( aMirrorAroundXAxis )
398  MIRROR( m_BezierPoints[ii].y, aCentre.y );
399  else
400  MIRROR( m_BezierPoints[ii].x, aCentre.x );
401  }
402 
403  break;
404 
405  case S_POLYGON:
406  // polygon corners coordinates are always relative to the
407  // footprint position, orientation 0
408  for( auto iter = m_Poly.Iterate(); iter; iter++ )
409  {
410  if( aMirrorAroundXAxis )
411  MIRROR( iter->y, aCentre.y );
412  else
413  MIRROR( iter->x, aCentre.x );
414  }
415  }
416 
417  SetDrawCoord();
418 }
wxPoint m_Bezier0_C2
Bezier Control Point 2, relative to module origin, orient 0.
STROKE_T GetShape() const
SHAPE_POLY_SET m_Poly
Stores the S_POLYGON shape.
polygon (not yet used for tracks, but could be in microwave apps)
usual segment : line with rounded ends
ITERATOR Iterate(int aFirst, int aLast, bool aIterateHoles=false)
Function Iterate returns an object to iterate through the points of the polygons between aFirst and a...
wxPoint m_End0
End point, relative to module origin, orient 0.
wxPoint m_Bezier0_C1
Bezier Control Point 1, relative to module origin, orient 0.
void MIRROR(T &aPoint, const T &aMirrorRef)
Definition: macros.h:122
Arcs (with rounded ends)
Bezier Curve.
double GetAngle() const
void SetDrawCoord()
Set draw coordinates (absolute values ) from relative coordinates.
void SetAngle(double aAngle)
Function SetAngle sets the angle for arcs, and normalizes it within the range 0 - 360 degrees.
wxPoint m_Start0
Start point or center, relative to module origin, orient 0.
std::vector< wxPoint > m_BezierPoints

References DRAWSEGMENT::GetAngle(), DRAWSEGMENT::GetShape(), SHAPE_POLY_SET::Iterate(), m_Bezier0_C1, m_Bezier0_C2, DRAWSEGMENT::m_BezierPoints, m_End0, DRAWSEGMENT::m_Poly, m_Start0, MIRROR(), S_ARC, S_CURVE, S_POLYGON, S_SEGMENT, DRAWSEGMENT::SetAngle(), and SetDrawCoord().

◆ Move() [1/2]

void EDGE_MODULE::Move ( const wxPoint &  aMoveVector)
overridevirtual

Move an edge of the footprint.

This is a footprint shape modification. (should be only called by a footprint editing function)

Reimplemented from DRAWSEGMENT.

Definition at line 433 of file class_edge_mod.cpp.

434 {
435  // Move an edge of the footprint.
436  // This is a footprint shape modification.
437  m_Start0 += aMoveVector;
438  m_End0 += aMoveVector;
439  m_Bezier0_C1 += aMoveVector;
440  m_Bezier0_C2 += aMoveVector;
441 
442  switch( GetShape() )
443  {
444  default:
445  break;
446 
447  case S_POLYGON:
448  // polygon corners coordinates are always relative to the
449  // footprint position, orientation 0
450  for( auto iter = m_Poly.Iterate(); iter; iter++ )
451  *iter += VECTOR2I( aMoveVector );
452 
453  break;
454  }
455 
456  SetDrawCoord();
457 }
wxPoint m_Bezier0_C2
Bezier Control Point 2, relative to module origin, orient 0.
STROKE_T GetShape() const
SHAPE_POLY_SET m_Poly
Stores the S_POLYGON shape.
polygon (not yet used for tracks, but could be in microwave apps)
ITERATOR Iterate(int aFirst, int aLast, bool aIterateHoles=false)
Function Iterate returns an object to iterate through the points of the polygons between aFirst and a...
VECTOR2< int > VECTOR2I
Definition: vector2d.h:587
wxPoint m_End0
End point, relative to module origin, orient 0.
wxPoint m_Bezier0_C1
Bezier Control Point 1, relative to module origin, orient 0.
void SetDrawCoord()
Set draw coordinates (absolute values ) from relative coordinates.
wxPoint m_Start0
Start point or center, relative to module origin, orient 0.

References DRAWSEGMENT::GetShape(), SHAPE_POLY_SET::Iterate(), m_Bezier0_C1, m_Bezier0_C2, m_End0, DRAWSEGMENT::m_Poly, m_Start0, S_POLYGON, and SetDrawCoord().

Referenced by MODULE::MoveAnchorPosition(), MoveMarkedItems(), MoveMarkedItemsExactly(), and FOOTPRINT_EDIT_FRAME::Place_EdgeMod().

◆ Move() [2/2]

void BOARD_ITEM::Move ( const VECTOR2I aMoveVector)
inlineinherited

Definition at line 239 of file class_board_item.h.

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

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

◆ Next()

◆ operator<()

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

Test if another item is less than this object.

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

Definition at line 231 of file base_struct.cpp.

232 {
233  wxFAIL_MSG( wxString::Format( wxT( "Less than operator not defined for item type %s." ),
234  GetChars( GetClass() ) ) );
235 
236  return false;
237 }
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:100
virtual wxString GetClass() const =0
Function GetClass returns the class name.
void Format(OUTPUTFORMATTER *out, int aNestLevel, int aCtl, CPTREE &aTree)
Function Format outputs a PTREE into s-expression format via an OUTPUTFORMATTER derivative.
Definition: ptree.cpp:205

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

◆ RebuildBezierToSegmentsPointsList()

void DRAWSEGMENT::RebuildBezierToSegmentsPointsList ( int  aMinSegLen)
inherited

Rebuild the m_BezierPoints vertex list that approximate the Bezier curve by a list of segments Has meaning only for S_CURVE DRAW_SEGMENT shape.

Parameters
aMinSegLenis the min length of segments approximating the shape. the last segment can be shorter This param avoid having too many very short segment in list. a good value is m_Width/2 to m_Width

Definition at line 216 of file class_drawsegment.cpp.

217 {
218  // Has meaning only for S_CURVE DRAW_SEGMENT shape
219  if( m_Shape != S_CURVE )
220  {
221  m_BezierPoints.clear();
222  return;
223  }
224  // Rebuild the m_BezierPoints vertex list that approximate the Bezier curve
225  std::vector<wxPoint> ctrlPoints = { m_Start, m_BezierC1, m_BezierC2, m_End };
226  BEZIER_POLY converter( ctrlPoints );
227  converter.GetPoly( m_BezierPoints, aMinSegLen );
228 }
wxPoint m_BezierC1
Bezier Control Point 1.
wxPoint m_Start
Line start point or Circle and Arc center.
wxPoint m_End
Line end point or circle and arc start point.
STROKE_T m_Shape
Shape: line, Circle, Arc.
Bezier Curve.
Bezier curves to polygon converter.
Definition: bezier_curves.h:35
wxPoint m_BezierC2
Bezier Control Point 2.
std::vector< wxPoint > m_BezierPoints

References BEZIER_POLY::GetPoly(), DRAWSEGMENT::m_BezierC1, DRAWSEGMENT::m_BezierC2, DRAWSEGMENT::m_BezierPoints, DRAWSEGMENT::m_End, DRAWSEGMENT::m_Shape, DRAWSEGMENT::m_Start, and S_CURVE.

Referenced by ConvertOutlineToPolygon(), Draw(), DRAWSEGMENT::Draw(), Flip(), SetDrawCoord(), PNS_KICAD_IFACE::syncGraphicalItem(), DRC::testCopperDrawItem(), DIALOG_GRAPHIC_ITEM_PROPERTIES::TransferDataFromWindow(), and POINT_EDITOR::updateItem().

◆ Replace() [1/2]

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

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

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

Definition at line 201 of file base_struct.cpp.

202 {
203  wxCHECK_MSG( IsReplaceable(), false,
204  wxT( "Attempt to replace text in <" ) + GetClass() + wxT( "> item." ) );
205 
206  wxString searchString = (aSearchData.GetFlags() & wxFR_MATCHCASE) ? aText : aText.Upper();
207 
208  int result = searchString.Find( (aSearchData.GetFlags() & wxFR_MATCHCASE) ?
209  aSearchData.GetFindString() :
210  aSearchData.GetFindString().Upper() );
211 
212  if( result == wxNOT_FOUND )
213  return false;
214 
215  wxString prefix = aText.Left( result );
216  wxString suffix;
217 
218  if( aSearchData.GetFindString().length() + result < aText.length() )
219  suffix = aText.Right( aText.length() - ( aSearchData.GetFindString().length() + result ) );
220 
221  wxLogTrace( traceFindReplace, wxT( "Replacing '%s', prefix '%s', replace '%s', suffix '%s'." ),
222  GetChars( aText ), GetChars( prefix ), GetChars( aSearchData.GetReplaceString() ),
223  GetChars( suffix ) );
224 
225  aText = prefix + aSearchData.GetReplaceString() + suffix;
226 
227  return true;
228 }
const wxChar *const traceFindReplace
Flag to enable find and replace debug tracing.
static const wxChar * GetChars(const wxString &s)
Function GetChars returns a wxChar* to the actual wxChar* data within a wxString, and is helpful for ...
Definition: macros.h:100
virtual wxString GetClass() const =0
Function GetClass returns the class name.
virtual bool IsReplaceable() const
Function IsReplaceable.
Definition: base_struct.h:502

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

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

◆ Replace() [2/2]

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

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

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

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

Reimplemented in SCH_SHEET, SCH_FIELD, SCH_SHEET_PIN, and SCH_TEXT.

Definition at line 490 of file base_struct.h.

490 { return false; }

◆ Rotate() [1/2]

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

Rotate an edge of the footprint.

This is a footprint shape modification. (should be only called by a footprint editing function )

Reimplemented from DRAWSEGMENT.

Definition at line 420 of file class_edge_mod.cpp.

421 {
422  // We should rotate the relative coordinates, but to avoid duplicate code,
423  // do the base class rotation of draw coordinates, which is acceptable
424  // because in module editor, m_Pos0 = m_Pos
425  DRAWSEGMENT::Rotate( aRotCentre, aAngle );
426 
427  // and now update the relative coordinates, which are
428  // the reference in most transforms.
429  SetLocalCoord();
430 }
void SetLocalCoord()
Set relative coordinates from draw coordinates.
virtual void Rotate(const wxPoint &aRotCentre, double aAngle) override
Function Rotate Rotate this object.

References DRAWSEGMENT::Rotate(), and SetLocalCoord().

Referenced by MoveMarkedItemsExactly(), and EAGLE_PLUGIN::packageRectangle().

◆ Rotate() [2/2]

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

Definition at line 255 of file class_board_item.h.

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

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

◆ SetAngle()

void DRAWSEGMENT::SetAngle ( double  aAngle)
inherited

Function SetAngle sets the angle for arcs, and normalizes it within the range 0 - 360 degrees.

Parameters
aAngleis tenths of degrees, but will soon be degrees.

Definition at line 322 of file class_drawsegment.cpp.

323 {
324  // m_Angle must be >= -360 and <= +360 degrees
325  m_Angle = NormalizeAngle360Max( aAngle );
326 }
T NormalizeAngle360Max(T Angle)
Normalize angle to be >=-360.0 and <= 360.0 Angle can be equal to -360 or +360.
Definition: trigo.h:220
double m_Angle
Used only for Arcs: Arc angle in 1/10 deg.

References DRAWSEGMENT::m_Angle, and NormalizeAngle360Max().

Referenced by PCAD2KICAD::PCB_ARC::AddToBoard(), PCAD2KICAD::PCB_ARC::AddToModule(), PCB_EDIT_FRAME::Begin_DrawSegment(), FOOTPRINT_EDIT_FRAME::Begin_Edge_Module(), PAD_CS_PRIMITIVE::ExportTo(), Flip(), EAGLE_PLUGIN::loadPlain(), Mirror(), EAGLE_PLUGIN::packageWire(), GPCB_FPL_CACHE::parseMODULE(), DIALOG_GRAPHIC_ITEM_PROPERTIES::TransferDataFromWindow(), updateArcFromConstructionMgr(), and POINT_EDITOR::updateItem().

◆ SetArcStart()

void DRAWSEGMENT::SetArcStart ( const wxPoint &  aArcStartPoint)
inlineinherited

Initialize the start arc point.

can be used for circles to initialize one point of the cicumference

Definition at line 157 of file class_drawsegment.h.

158  { m_End = aArcStartPoint; }
wxPoint m_End
Line end point or circle and arc start point.

References DRAWSEGMENT::m_End.

Referenced by updateArcFromConstructionMgr(), and POINT_EDITOR::updateItem().

◆ SetBack()

void EDA_ITEM::SetBack ( EDA_ITEM aBack)
inlineinherited

Definition at line 218 of file base_struct.h.

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

References EDA_ITEM::Pback.

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

◆ SetBezControl1()

void DRAWSEGMENT::SetBezControl1 ( const wxPoint &  aPoint)
inlineinherited

Definition at line 100 of file class_drawsegment.h.

100 { m_BezierC1 = aPoint; }
wxPoint m_BezierC1
Bezier Control Point 1.

References DRAWSEGMENT::m_BezierC1.

Referenced by PAD_CS_PRIMITIVE::ExportTo(), DIALOG_GRAPHIC_ITEM_PROPERTIES::TransferDataFromWindow(), and POINT_EDITOR::updateItem().

◆ SetBezControl2()

void DRAWSEGMENT::SetBezControl2 ( const wxPoint &  aPoint)
inlineinherited

Definition at line 103 of file class_drawsegment.h.

103 { m_BezierC2 = aPoint; }
wxPoint m_BezierC2
Bezier Control Point 2.

References DRAWSEGMENT::m_BezierC2.

Referenced by PAD_CS_PRIMITIVE::ExportTo(), DIALOG_GRAPHIC_ITEM_PROPERTIES::TransferDataFromWindow(), and POINT_EDITOR::updateItem().

◆ SetBezier0_C1()

void EDGE_MODULE::SetBezier0_C1 ( const wxPoint &  aPoint)
inline

Definition at line 99 of file class_edge_mod.h.

99 { m_Bezier0_C1 = aPoint; }
wxPoint m_Bezier0_C1
Bezier Control Point 1, relative to module origin, orient 0.

References m_Bezier0_C1.

Referenced by MoveMarkedItems(), and DIALOG_GRAPHIC_ITEM_PROPERTIES::TransferDataFromWindow().

◆ SetBezier0_C2()

void EDGE_MODULE::SetBezier0_C2 ( const wxPoint &  aPoint)
inline

Definition at line 102 of file class_edge_mod.h.

102 { m_Bezier0_C2 = aPoint; }
wxPoint m_Bezier0_C2
Bezier Control Point 2, relative to module origin, orient 0.

References m_Bezier0_C2.

Referenced by MoveMarkedItems(), and DIALOG_GRAPHIC_ITEM_PROPERTIES::TransferDataFromWindow().

◆ SetBezierPoints()

void DRAWSEGMENT::SetBezierPoints ( const std::vector< wxPoint > &  aPoints)
inlineinherited

Definition at line 197 of file class_drawsegment.h.

198  {
199  m_BezierPoints = aPoints;
200  }
std::vector< wxPoint > m_BezierPoints

References DRAWSEGMENT::m_BezierPoints.

◆ SetBrightened()

void EDA_ITEM::SetBrightened ( )
inlineinherited

Definition at line 235 of file base_struct.h.

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

References BRIGHTENED, and EDA_ITEM::SetFlags().

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

◆ SetCenter()

void DRAWSEGMENT::SetCenter ( const wxPoint &  aCenterPoint)
inlineinherited

For arcs and circles:

Definition at line 162 of file class_drawsegment.h.

162 { m_Start = aCenterPoint; }
wxPoint m_Start
Line start point or Circle and Arc center.

References DRAWSEGMENT::m_Start.

Referenced by updateArcFromConstructionMgr(), and POINT_EDITOR::updateItem().

◆ SetDrawCoord()

void EDGE_MODULE::SetDrawCoord ( )

Set draw coordinates (absolute values ) from relative coordinates.

Must be called when a relative coordinate has changed, in order to see the changes on screen

Definition at line 95 of file class_edge_mod.cpp.

96 {
97  MODULE* module = (MODULE*) m_Parent;
98 
99  m_Start = m_Start0;
100  m_End = m_End0;
103 
104  if( module )
105  {
106  RotatePoint( &m_Start.x, &m_Start.y, module->GetOrientation() );
107  RotatePoint( &m_End.x, &m_End.y, module->GetOrientation() );
108  RotatePoint( &m_BezierC1.x, &m_BezierC1.y, module->GetOrientation() );
109  RotatePoint( &m_BezierC2.x, &m_BezierC2.y, module->GetOrientation() );
110 
111  m_Start += module->GetPosition();
112  m_End += module->GetPosition();
113  m_BezierC1 += module->GetPosition();
114  m_BezierC2 += module->GetPosition();
115  }
116 
118 }
wxPoint m_Bezier0_C2
Bezier Control Point 2, relative to module origin, orient 0.
double GetOrientation() const
Definition: class_module.h:188
EDA_ITEM * m_Parent
Linked list: Link (parent struct)
Definition: base_struct.h:174
void RebuildBezierToSegmentsPointsList(int aMinSegLen)
Rebuild the m_BezierPoints vertex list that approximate the Bezier curve by a list of segments Has me...
void RotatePoint(int *pX, int *pY, double angle)
Definition: trigo.cpp:216
wxPoint m_End0
End point, relative to module origin, orient 0.
wxPoint m_BezierC1
Bezier Control Point 1.
wxPoint m_Bezier0_C1
Bezier Control Point 1, relative to module origin, orient 0.
wxPoint m_Start
Line start point or Circle and Arc center.
wxPoint m_End
Line end point or circle and arc start point.
wxPoint m_BezierC2
Bezier Control Point 2.
int m_Width
thickness of lines ...
wxPoint m_Start0
Start point or center, relative to module origin, orient 0.
const wxPoint GetPosition() const override
Definition: class_module.h:183

References MODULE::GetOrientation(), MODULE::GetPosition(), m_Bezier0_C1, m_Bezier0_C2, DRAWSEGMENT::m_BezierC1, DRAWSEGMENT::m_BezierC2, DRAWSEGMENT::m_End, m_End0, EDA_ITEM::m_Parent, DRAWSEGMENT::m_Start, m_Start0, DRAWSEGMENT::m_Width, DRAWSEGMENT::RebuildBezierToSegmentsPointsList(), and RotatePoint().

Referenced by PCAD2KICAD::PCB_LINE::AddToModule(), PCAD2KICAD::PCB_ARC::AddToModule(), PCAD2KICAD::PCB_POLYGON::AddToModule(), LEGACY_PLUGIN::loadMODULE_EDGE(), Mirror(), Move(), EAGLE_PLUGIN::packageCircle(), EAGLE_PLUGIN::packagePolygon(), EAGLE_PLUGIN::packageWire(), GPCB_FPL_CACHE::parseMODULE(), PCB_PARSER::parseMODULE_unchecked(), and MODULE::SetPosition().

◆ SetEnd()

◆ SetEnd0()

◆ SetEndX()

void DRAWSEGMENT::SetEndX ( int  x)
inlineinherited

Definition at line 125 of file class_drawsegment.h.

125 { m_End.x = x; }
wxPoint m_End
Line end point or circle and arc start point.

References DRAWSEGMENT::m_End.

Referenced by DIALOG_GRAPHIC_ITEM_PROPERTIES::TransferDataFromWindow().

◆ SetEndY()

void DRAWSEGMENT::SetEndY ( int  y)
inlineinherited

Definition at line 124 of file class_drawsegment.h.

124 { m_End.y = y; }
wxPoint m_End
Line end point or circle and arc start point.

References DRAWSEGMENT::m_End.

Referenced by DIALOG_GRAPHIC_ITEM_PROPERTIES::TransferDataFromWindow().

◆ SetFlags()

void EDA_ITEM::SetFlags ( STATUS_FLAGS  aMask)
inlineinherited

Definition at line 259 of file base_struct.h.

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

References EDA_ITEM::m_Flags.

Referenced by SCH_EAGLE_PLUGIN::addBusEntries(), PCB_BASE_FRAME::AddModuleToBoard(), AddSegmentToDragList(), PCBNEW_CONTROL::AppendBoard(), 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(), LIB_ITEM::BeginEdit(), PCB_EDIT_FRAME::BeginMoveDimensionText(), PCB_EDIT_FRAME::BeginMoveTarget(), PCB_EDIT_FRAME::Change_Side_Module(), SCH_EDIT_FRAME::ConvertPart(), SCH_EDIT_FRAME::ConvertTextType(), CopyMarkedItems(), SCH_EDIT_FRAME::CreateNewText(), LIB_PIN_TOOL::CreatePin(), SCH_EDIT_FRAME::CreateSheetPin(), PCB_EDIT_FRAME::CreateTarget(), PCB_EDIT_FRAME::CreateTextePcb(), FOOTPRINT_EDIT_FRAME::CreateTextModule(), SCH_WIRE_BUS_TOOL::doDrawSegments(), SCH_DRAWING_TOOLS::doPlaceComponent(), SCH_DRAWING_TOOLS::doSingleClickPlace(), LIB_DRAWING_TOOLS::doTwoClickPlace(), SCH_DRAWING_TOOLS::doTwoClickPlace(), KIGFX::SCH_PAINTER::draw(), SCH_DRAWING_TOOLS::DrawSheet(), LIB_EDIT_TOOL::Duplicate(), SCH_EDIT_TOOL::Duplicate(), PCB_EDIT_FRAME::EditDimension(), PCB_EDIT_FRAME::FlipTextePcb(), LIB_EDIT_FRAME::GetComponentFromRedoList(), LIB_EDIT_FRAME::GetComponentFromUndoList(), SCH_MOVE_TOOL::getConnectedDragItems(), FOOTPRINT_EDIT_FRAME::HandleBlockEnd(), KIGFX::SCH_VIEW::HighlightItem(), PCB_BASE_FRAME::Import_Pad_Settings(), SCH_EDIT_FRAME::ImportSheetPin(), InvokeDialogImportGfxBoard(), InvokeDialogImportGfxModule(), EDIT_POINTS_FACTORY::Make(), SCH_SCREEN::MarkConnections(), MarkItemsInBloc(), SCH_MOVE_TOOL::moveItem(), LIB_MOVE_TOOL::moveItem(), KIGFX::ORIGIN_VIEWITEM::ORIGIN_VIEWITEM(), PCB_EDIT_FRAME::Other_Layer_Route(), LIB_EDIT_TOOL::Paste(), SCH_EDITOR_CONTROL::Paste(), SCH_DRAWING_TOOLS::PlaceImage(), PCB_EDITOR_CONTROL::PlaceModule(), DRAWING_TOOL::PlaceText(), SCH_EDIT_FRAME::PutDataInPreviousState(), SCH_EDIT_TOOL::RepeatDrawItem(), LIB_PIN_TOOL::RepeatPin(), PCB_BASE_FRAME::Rotate_Module(), PCB_EDIT_FRAME::Rotate_Texte_Pcb(), LIB_EDIT_FRAME::SaveCopyInUndoList(), SCH_EDIT_FRAME::SelectUnit(), EDA_ITEM::SetBrightened(), LIB_PIN::SetConversion(), BLOCK_SELECTOR::SetFlags(), 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(), PCB_BASE_FRAME::StartMoveTexteModule(), PCB_EDIT_FRAME::StartMoveTextePcb(), SCH_WIRE_BUS_TOOL::startSegments(), DIALOG_TEXT_PROPERTIES::TransferDataFromWindow(), DIALOG_EDIT_COMPONENT_IN_SCHEMATIC::TransferDataFromWindow(), DIALOG_TARGET_PROPERTIES::TransferDataFromWindow(), DIALOG_PAD_PROPERTIES::TransferDataFromWindow(), and UndrawAndMarkSegmentsToDrag().

◆ SetForceVisible()

void EDA_ITEM::SetForceVisible ( bool  aEnable)
inlineinherited

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

Parameters
aEnableTrue forces the item to be drawn. False uses the item's visibility setting to determine if the item is to be drawn.

Definition at line 309 of file base_struct.h.

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

References EDA_ITEM::m_forceVisible.

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

◆ SetHighlighted()

void EDA_ITEM::SetHighlighted ( )
inlineinherited

Definition at line 234 of file base_struct.h.

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

References HIGHLIGHTED, and EDA_ITEM::SetFlags().

◆ SetLayer()

virtual void BOARD_ITEM::SetLayer ( PCB_LAYER_ID  aLayer)
inlinevirtualinherited

Function SetLayer sets the layer this item is on.

Parameters
aLayerThe layer number. is virtual because some items (in fact: class DIMENSION) have a slightly different initialization

Reimplemented in ZONE_CONTAINER, and DIMENSION.

Definition at line 140 of file class_board_item.h.

141  {
142  // trap any invalid layers, then go find the caller and fix it.
143  // wxASSERT( unsigned( aLayer ) < unsigned( NB_PCB_LAYERS ) );
144  m_Layer = aLayer;
145  }
PCB_LAYER_ID m_Layer

References BOARD_ITEM::m_Layer.

Referenced by PNS_KICAD_IFACE::AddItem(), PCAD2KICAD::PCB_TEXT::AddToBoard(), PCAD2KICAD::PCB_LINE::AddToBoard(), PCAD2KICAD::PCB_ARC::AddToBoard(), PCAD2KICAD::PCB_PAD::AddToBoard(), PCAD2KICAD::PCB_MODULE::AddToBoard(), PCAD2KICAD::PCB_LINE::AddToModule(), PCAD2KICAD::PCB_ARC::AddToModule(), PCAD2KICAD::PCB_POLYGON::AddToModule(), DIMENSION::AdjustDimensionDetails(), PCB_EDIT_FRAME::Begin_DrawSegment(), FOOTPRINT_EDIT_FRAME::Begin_Edge_Module(), PCB_EDIT_FRAME::Begin_Route(), PCB_EDIT_FRAME::Create_MuWavePolygonShape(), MWAVE::CreateMicrowaveInductor(), PCB_BASE_FRAME::CreateNewModule(), PCB_EDIT_FRAME::CreateTarget(), PCB_EDIT_FRAME::CreateTextePcb(), FOOTPRINT_EDIT_FRAME::CreateTextModule(), DRAWING_TOOL::drawArc(), DRAWING_TOOL::drawSegment(), FOOTPRINT_EDIT_FRAME::Edit_Edge_Layer(), TEXTE_PCB::Flip(), PCB_TARGET::Flip(), Flip(), TEXTE_MODULE::Flip(), TRACK::Flip(), MODULE::Flip(), DRAWSEGMENT::Flip(), LEGACY_PLUGIN::loadMODULE(), LEGACY_PLUGIN::loadMODULE_TEXT(), LEGACY_PLUGIN::loadPCB_TEXT(), EAGLE_PLUGIN::loadPlain(), EAGLE_PLUGIN::loadSignals(), LEGACY_PLUGIN::loadTrackList(), DSN::SPECCTRA_DB::makeTRACK(), DIALOG_FOOTPRINT_FP_EDITOR::OnAddField(), DIALOG_FOOTPRINT_BOARD_EDITOR::OnAddField(), PCB_EDIT_FRAME::Other_Layer_Route(), EAGLE_PLUGIN::packageCircle(), EAGLE_PLUGIN::packagePolygon(), EAGLE_PLUGIN::packageRectangle(), EAGLE_PLUGIN::packageSMD(), EAGLE_PLUGIN::packageText(), EAGLE_PLUGIN::packageWire(), GPCB_FPL_CACHE::parseMODULE(), PCB_EDITOR_CONTROL::PlaceTarget(), DRAWING_TOOL::PlaceText(), BRDITEMS_PLOTTER::PlotDimension(), BRDITEMS_PLOTTER::PlotPcbTarget(), processBoardItem(), DIALOG_GLOBAL_EDIT_TRACKS_AND_VIAS::processItem(), DIALOG_GLOBAL_EDIT_TEXT_AND_GRAPHICS::processItem(), processTextItem(), DIALOG_PAD_PROPERTIES::redraw(), DIMENSION::SetLayer(), TEXT_MOD_GRID_TABLE::SetValueAsLong(), ShowNewTrackWhenMovingCursor(), TEXTE_MODULE::TEXTE_MODULE(), DIALOG_TRACK_VIA_PROPERTIES::TransferDataFromWindow(), DIALOG_TEXT_PROPERTIES::TransferDataFromWindow(), and DIALOG_GRAPHIC_ITEM_PROPERTIES::TransferDataFromWindow().

◆ SetList()

void EDA_ITEM::SetList ( DHEAD aList)
inlineinherited

Definition at line 220 of file base_struct.h.

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

References EDA_ITEM::m_List.

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

◆ SetLocalCoord()

void EDGE_MODULE::SetLocalCoord ( )

Set relative coordinates from draw coordinates.

Call in only when the geometry ov the footprint is modified and therefore the relative coordinates have to be updated from the draw coordinates

Definition at line 70 of file class_edge_mod.cpp.

71 {
72  MODULE* module = (MODULE*) m_Parent;
73 
74  if( module == NULL )
75  {
76  m_Start0 = m_Start;
77  m_End0 = m_End;
80  return;
81  }
82 
83  m_Start0 = m_Start - module->GetPosition();
84  m_End0 = m_End - module->GetPosition();
85  m_Bezier0_C1 = m_BezierC1 - module->GetPosition();
86  m_Bezier0_C2 = m_BezierC2 - module->GetPosition();
87  double angle = module->GetOrientation();
88  RotatePoint( &m_Start0.x, &m_Start0.y, -angle );
89  RotatePoint( &m_End0.x, &m_End0.y, -angle );
92 }
wxPoint m_Bezier0_C2
Bezier Control Point 2, relative to module origin, orient 0.
double GetOrientation() const
Definition: class_module.h:188
EDA_ITEM * m_Parent
Linked list: Link (parent struct)
Definition: base_struct.h:174
void RotatePoint(int *pX, int *pY, double angle)
Definition: trigo.cpp:216
wxPoint m_End0
End point, relative to module origin, orient 0.
wxPoint m_BezierC1
Bezier Control Point 1.
wxPoint m_Bezier0_C1
Bezier Control Point 1, relative to module origin, orient 0.
wxPoint m_Start
Line start point or Circle and Arc center.
wxPoint m_End
Line end point or circle and arc start point.
static DIRECTION_45::AngleType angle(const VECTOR2I &a, const VECTOR2I &b)
wxPoint m_BezierC2
Bezier Control Point 2.
wxPoint m_Start0
Start point or center, relative to module origin, orient 0.
const wxPoint GetPosition() const override
Definition: class_module.h:183

References PNS::angle(), MODULE::GetOrientation(), MODULE::GetPosition(), m_Bezier0_C1, m_Bezier0_C2, DRAWSEGMENT::m_BezierC1, DRAWSEGMENT::m_BezierC2, DRAWSEGMENT::m_End, m_End0, EDA_ITEM::m_Parent, DRAWSEGMENT::m_Start, m_Start0, and RotatePoint().

Referenced by PAD_CS_PRIMITIVE::ExportTo(), and Rotate().

◆ SetLocked()

virtual void BOARD_ITEM::SetLocked ( bool  aLocked)
inlinevirtualinherited

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

Reimplemented in MODULE, and TRACK.

Definition at line 203 of file class_board_item.h.

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

◆ SetModified()

◆ SetNext()

void EDA_ITEM::SetNext ( EDA_ITEM aNext)
inlineinherited

Definition at line 217 of file base_struct.h.

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

References EDA_ITEM::Pnext.

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

◆ SetParent()

◆ SetPolyPoints()

void DRAWSEGMENT::SetPolyPoints ( const std::vector< wxPoint > &  aPoints)
inherited

Definition at line 966 of file class_drawsegment.cpp.

967 {
969  m_Poly.NewOutline();
970 
971  for ( auto p : aPoints )
972  {
973  m_Poly.Append( p.x, p.y );
974  }
975 }
SHAPE_POLY_SET m_Poly
Stores the S_POLYGON shape.
int NewOutline()
Creates a new empty polygon in the set and returns its index
void RemoveAllContours()
Removes all outlines & holes (clears) the polygon set.
int Append(int x, int y, int aOutline=-1, int aHole=-1, bool aAllowDuplication=false)
Appends a vertex at the end of the given outline/hole (default: the last outline)

References SHAPE_POLY_SET::Append(), DRAWSEGMENT::m_Poly, SHAPE_POLY_SET::NewOutline(), and SHAPE_POLY_SET::RemoveAllContours().

Referenced by PCAD2KICAD::PCB_POLYGON::AddToModule(), PCB_EDIT_FRAME::Create_MuWavePolygonShape(), PAD_CS_PRIMITIVE::ExportTo(), EAGLE_PLUGIN::packagePolygon(), and EAGLE_PLUGIN::packageRectangle().

◆ SetPolyShape()

void DRAWSEGMENT::SetPolyShape ( const SHAPE_POLY_SET aShape)
inlineinherited

Definition at line 195 of file class_drawsegment.h.

195 { m_Poly = aShape; }
SHAPE_POLY_SET m_Poly
Stores the S_POLYGON shape.

References DRAWSEGMENT::m_Poly.

◆ SetPosition()

void DRAWSEGMENT::SetPosition ( const wxPoint &  aPos)
overridevirtualinherited

Implements BOARD_ITEM.

Definition at line 68 of file class_drawsegment.cpp.

69 {
70  m_Start = aPos;
71 }
wxPoint m_Start
Line start point or Circle and Arc center.

References DRAWSEGMENT::m_Start.

◆ SetSelected()

void EDA_ITEM::SetSelected ( )
inlineinherited

Definition at line 233 of file base_struct.h.

233 { SetFlags( SELECTED ); }
#define SELECTED
Definition: base_struct.h:121
void SetFlags(STATUS_FLAGS aMask)
Definition: base_struct.h:259

References SELECTED, and EDA_ITEM::SetFlags().

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

◆ SetShape()

◆ SetStart()

◆ SetStart0()

◆ SetStartX()

void DRAWSEGMENT::SetStartX ( int  x)
inlineinherited

Definition at line 116 of file class_drawsegment.h.

116 { m_Start.x = x; }
wxPoint m_Start
Line start point or Circle and Arc center.

References DRAWSEGMENT::m_Start.

Referenced by DIALOG_GRAPHIC_ITEM_PROPERTIES::TransferDataFromWindow().

◆ SetStartY()

void DRAWSEGMENT::SetStartY ( int  y)
inlineinherited

Definition at line 115 of file class_drawsegment.h.

115 { m_Start.y = y; }
wxPoint m_Start
Line start point or Circle and Arc center.

References DRAWSEGMENT::m_Start.

Referenced by DIALOG_GRAPHIC_ITEM_PROPERTIES::TransferDataFromWindow().

◆ SetState()

◆ SetStatus()

void EDA_ITEM::SetStatus ( STATUS_FLAGS  aStatus)
inlineinherited

◆ SetTimeStamp()

void EDA_ITEM::SetTimeStamp ( timestamp_t  aNewTimeStamp)
inlineinherited

Definition at line 209 of file base_struct.h.

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

References EDA_ITEM::m_TimeStamp.

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

◆ SetType()

void DRAWSEGMENT::SetType ( int  aType)
inlineinherited

Definition at line 94 of file class_drawsegment.h.

94 { m_Type = aType; }
int m_Type
Used in complex associations ( Dimensions.. )

References DRAWSEGMENT::m_Type.

Referenced by PCB_EDIT_FRAME::Begin_DrawSegment().

◆ SetWidth()

◆ SetWireImage()

void EDA_ITEM::SetWireImage ( )
inlineinherited

Definition at line 232 of file base_struct.h.

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

References IS_WIRE_IMAGE, and EDA_ITEM::SetFlags().

◆ ShowShape()

wxString BOARD_ITEM::ShowShape ( STROKE_T  aShape)
staticinherited

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

Definition at line 39 of file class_board_item.cpp.

40 {
41  switch( aShape )
42  {
43  case S_SEGMENT: return _( "Line" );
44  case S_RECT: return _( "Rect" );
45  case S_ARC: return _( "Arc" );
46  case S_CIRCLE: return _( "Circle" );
47  case S_CURVE: return _( "Bezier Curve" );
48  case S_POLYGON: return _( "Polygon" );
49  default: return wxT( "??" );
50  }
51 }
polygon (not yet used for tracks, but could be in microwave apps)
usual segment : line with rounded ends
segment with non rounded ends
Arcs (with rounded ends)
Bezier Curve.

References S_ARC, S_CIRCLE, S_CURVE, S_POLYGON, S_RECT, and S_SEGMENT.

Referenced by ConvertOutlineToPolygon(), DRAWSEGMENT::GetCenter(), GetSelectMenuText(), DRAWSEGMENT::GetSelectMenuText(), DSN::SPECCTRA_DB::makeIMAGE(), and DRAWSEGMENT::Rotate().

◆ Sort()

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

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

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

Definition at line 521 of file base_struct.h.

521 { return *aLeft < *aRight; }

Referenced by PART_LIB::GetEntryTypePowerNames().

◆ SwapData()

void DRAWSEGMENT::SwapData ( BOARD_ITEM aImage)
overridevirtualinherited

Swap data between aItem and aImage.

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

Parameters
aImage= the item image which contains data to swap

Reimplemented from BOARD_ITEM.

Definition at line 1020 of file class_drawsegment.cpp.

1021 {
1022  assert( aImage->Type() == PCB_LINE_T );
1023 
1024  std::swap( *((DRAWSEGMENT*) this), *((DRAWSEGMENT*) aImage) );
1025 }
class DRAWSEGMENT, a segment not on copper layers
Definition: typeinfo.h:91
KICAD_T Type() const
Function Type()
Definition: base_struct.h:204

References PCB_LINE_T, and EDA_ITEM::Type().

◆ TransformShapeWithClearanceToPolygon()

void DRAWSEGMENT::TransformShapeWithClearanceToPolygon ( SHAPE_POLY_SET aCornerBuffer,
int  aClearanceValue,
int  aCircleToSegmentsCount,
double  aCorrectionFactor,
bool  ignoreLineWidth = false 
) const
overridevirtualinherited

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

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

Parameters
aCornerBuffer= a buffer to store the polygon
aClearanceValue= the clearance around the pad
aCircleToSegmentsCount= the number of segments to approximate a circle
aCorrectionFactor= the correction to apply to circles radius to keep clearance when the circle is approximated by segment bigger or equal to the real clearance value (usually near from 1.0)
ignoreLineWidth= used for edge cut items where the line width is only for visualization
aCornerBuffer= a buffer to store the polygon
aClearanceValue= the clearance around the pad
aCircleToSegmentsCount= the number of segments to approximate a circle
aCorrectionFactor= the correction to apply to circles radius to keep clearance when the circle is approxiamted by segment bigger or equal to the real clearance value (usually near from 1.0)
ignoreLineWidth= used for edge cut items where the line width is only for visualization

Reimplemented from BOARD_ITEM.

Definition at line 516 of file board_items_to_polygon_shape_transform.cpp.

521 {
522  // The full width of the lines to create:
523  int linewidth = ignoreLineWidth ? 0 : m_Width;
524 
525  linewidth += 2 * aClearanceValue;
526 
527  // Creating a reliable clearance shape for circles and arcs is not so easy, due to
528  // the error created by segment approximation.
529  // for a cicle this is not so hard: create a polygon from a circle slightly bigger:
530  // thickness = linewidth + s_error_max, and radius = initial radius + s_error_max/2
531  // giving a shape with a suitable internal radius and external radius
532  // For an arc this is more tricky: TODO
533  if( m_Shape == S_CIRCLE || m_Shape == S_ARC )
534  {
535  int segCount = GetArcToSegmentCount( GetRadius(), s_error_max, 360.0 );
536 
537  if( segCount > aCircleToSegmentsCount )
538  aCircleToSegmentsCount = segCount;
539  }
540 
541  switch( m_Shape )
542  {
543  case S_CIRCLE:
544  TransformRingToPolygon( aCornerBuffer, GetCenter(), GetRadius() + (s_error_max/2),
545  aCircleToSegmentsCount, linewidth + s_error_max ) ;
546  break;
547 
548  case S_ARC:
549  TransformArcToPolygon( aCornerBuffer, GetCenter(),
550  GetArcStart(), m_Angle,
551  aCircleToSegmentsCount, linewidth );
552  break;
553 
554  case S_SEGMENT:
555  TransformOvalClearanceToPolygon( aCornerBuffer, m_Start, m_End, linewidth,
556  aCircleToSegmentsCount, aCorrectionFactor );
557  break;
558 
559  case S_POLYGON:
560  if( IsPolyShapeValid() )
561  {
562  // The polygon is expected to be a simple polygon
563  // not self intersecting, no hole.
564  MODULE* module = GetParentModule(); // NULL for items not in footprints
565  double orientation = module ? module->GetOrientation() : 0.0;
566  wxPoint offset;
567 
568  if( module )
569  offset = module->GetPosition();
570 
571  // Build the polygon with the actual position and orientation:
572  std::vector< wxPoint> poly;
573  poly = BuildPolyPointsList();
574 
575  for( unsigned ii = 0; ii < poly.size(); ii++ )
576  {
577  RotatePoint( &poly[ii], orientation );
578  poly[ii] += offset;
579  }
580 
581  // If the polygon is not filled, treat it as a closed set of lines
582  if( !IsPolygonFilled() )
583  {
584  for( size_t ii = 1; ii < poly.size(); ii++ )
585  {
586  TransformOvalClearanceToPolygon( aCornerBuffer, poly[ii - 1], poly[ii],
587  linewidth, aCircleToSegmentsCount, aCorrectionFactor );
588  }
589 
590  TransformOvalClearanceToPolygon( aCornerBuffer, poly.back(), poly.front(),
591  linewidth, aCircleToSegmentsCount, aCorrectionFactor );
592  break;
593  }
594 
595  // Generate polygons for the outline + clearance
596  // This code is compatible with a polygon with holes linked to external outline
597  // by overlapping segments.
598 
599  // Insert the initial polygon:
600  aCornerBuffer.NewOutline();
601 
602  for( unsigned ii = 0; ii < poly.size(); ii++ )
603  aCornerBuffer.Append( poly[ii].x, poly[ii].y );
604 
605  if( linewidth ) // Add thick outlines
606  {
607  wxPoint corner1( poly[poly.size()-1] );
608 
609  for( unsigned ii = 0; ii < poly.size(); ii++ )
610  {
611  wxPoint corner2( poly[ii] );
612 
613  if( corner2 != corner1 )
614  {
616  corner1, corner2, aCircleToSegmentsCount, linewidth );
617  }
618 
619  corner1 = corner2;
620  }
621  }
622  }
623  break;
624 
625  case S_CURVE: // Bezier curve
626  {
627  std::vector<wxPoint> ctrlPoints = { m_Start, m_BezierC1, m_BezierC2, m_End };
628  BEZIER_POLY converter( ctrlPoints );
629  std::vector< wxPoint> poly;
630  converter.GetPoly( poly, m_Width );
631 
632  for( unsigned ii = 1; ii < poly.size(); ii++ )
633  {
635  poly[ii-1], poly[ii], aCircleToSegmentsCount, linewidth );
636  }
637  }
638  break;
639 
640  default:
641  break;
642  }
643 }
void TransformRoundedEndsSegmentToPolygon(SHAPE_POLY_SET &aCornerBuffer, wxPoint aStart, wxPoint aEnd, int aCircleToSegmentsCount, int aWidth)
Function TransformRoundedEndsSegmentToPolygon convert a segment with rounded ends to a polygon Conver...
double GetOrientation() const
Definition: class_module.h:188
int GetArcToSegmentCount(int aRadius, int aErrorMax, double aArcAngleDegree)
const wxPoint GetCenter() const override
Function GetCenter()
polygon (not yet used for tracks, but could be in microwave apps)
usual segment : line with rounded ends
void RotatePoint(int *pX, int *pY, double angle)
Definition: trigo.cpp:216
double m_Angle
Used only for Arcs: Arc angle in 1/10 deg.
void TransformOvalClearanceToPolygon(SHAPE_POLY_SET &aCornerBuffer, wxPoint aStart, wxPoint aEnd, int aWidth, int aCircleToSegmentsCount, double aCorrectionFactor)
convert a oblong shape to a polygon, using multiple segments It is similar to TransformRoundedEndsSeg...
const std::vector< wxPoint > BuildPolyPointsList() const
Build and return the list of corners in a std::vector<wxPoint> It must be used only to convert the SH...
wxPoint m_BezierC1
Bezier Control Point 1.
wxPoint m_Start
Line start point or Circle and Arc center.
wxPoint m_End
Line end point or circle and arc start point.
Arcs (with rounded ends)
MODULE * GetParentModule() const
Function GetParentModule returns a pointer to the parent module, or NULL if DRAWSEGMENT does not belo...
STROKE_T m_Shape
Shape: line, Circle, Arc.
const wxPoint & GetArcStart() const
int GetRadius() const
Function GetRadius returns the radius of this item Has meaning only for arc and circle.
Bezier Curve.
int NewOutline()
Creates a new empty polygon in the set and returns its index
void TransformRingToPolygon(SHAPE_POLY_SET &aCornerBuffer, wxPoint aCentre, int aRadius, int aCircleToSegmentsCount, int aWidth)
Function TransformRingToPolygon Creates a polygon from a ring Convert arcs to multiple straight segme...
Bezier curves to polygon converter.
Definition: bezier_curves.h:35
void TransformArcToPolygon(SHAPE_POLY_SET &aCornerBuffer, wxPoint aCentre, wxPoint aStart, double aArcAngle, int aCircleToSegmentsCount, int aWidth)
Function TransformArcToPolygon Creates a polygon from an Arc Convert arcs to multiple straight segmen...
wxPoint m_BezierC2
Bezier Control Point 2.
bool IsPolyShapeValid() const
int m_Width
thickness of lines ...
bool IsPolygonFilled() const
Polygonal shape is not always filled.
const wxPoint GetPosition() const override
Definition: class_module.h:183
int Append(int x, int y, int aOutline=-1, int aHole=-1, bool aAllowDuplication=false)
Appends a vertex at the end of the given outline/hole (default: the last outline)

References SHAPE_POLY_SET::Append(), DRAWSEGMENT::BuildPolyPointsList(), DRAWSEGMENT::GetArcStart(), GetArcToSegmentCount(), DRAWSEGMENT::GetCenter(), MODULE::GetOrientation(), DRAWSEGMENT::GetParentModule(), BEZIER_POLY::GetPoly(), MODULE::GetPosition(), DRAWSEGMENT::GetRadius(), DRAWSEGMENT::IsPolygonFilled(), DRAWSEGMENT::IsPolyShapeValid(), DRAWSEGMENT::m_Angle, DRAWSEGMENT::m_BezierC1, DRAWSEGMENT::m_BezierC2, DRAWSEGMENT::m_End, DRAWSEGMENT::m_Shape, DRAWSEGMENT::m_Start, DRAWSEGMENT::m_Width, SHAPE_POLY_SET::NewOutline(), RotatePoint(), S_ARC, S_CIRCLE, S_CURVE, s_error_max, S_POLYGON, S_SEGMENT, TransformArcToPolygon(), TransformOvalClearanceToPolygon(), TransformRingToPolygon(), and TransformRoundedEndsSegmentToPolygon().

Referenced by CINFO3D_VISU::AddShapeWithClearanceToContainer(), CINFO3D_VISU::transformGraphicModuleEdgeToPolygonSet(), and MODULE::TransformGraphicShapesWithClearanceToPolygonSet().

◆ Type()

KICAD_T EDA_ITEM::Type ( ) const
inlineinherited

Function Type()

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

Returns
KICAD_T - the type of object.

Definition at line 204 of file base_struct.h.

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

References EDA_ITEM::m_StructType.

Referenced by Abort_Move_ModuleOutline(), MODULE::Add(), CN_CONNECTIVITY_ALGO::Add(), BOARD::Add(), CN_CLUSTER::Add(), PCB_EDIT_FRAME::Add45DegreeSegment(), POINT_EDITOR::addCorner(), CONNECTION_SUBGRAPH::AddItem(), SCH_EDIT_FRAME::AddItemToScreenAndUndoList(), SCH_MOVE_TOOL::addJunctionsIfNeeded(), SCH_SHEET::AddPin(), ALIGN_DISTRIBUTE_TOOL::AlignBottom(), ALIGN_DISTRIBUTE_TOOL::AlignCenterX(), ALIGN_DISTRIBUTE_TOOL::AlignCenterY(), ALIGN_DISTRIBUTE_TOOL::AlignTop(), CN_ITEM::AnchorCount(), PCB_EDIT_FRAME::Begin_Route(), 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(), CONNECTION_GRAPH::buildConnectionGraph(), HIERARCHY_NAVIG_DLG::buildHierarchyTree(), SCH_SCREENS::buildScreenList(), SCH_SHEET_LIST::BuildSheetList(), calcArea(), calcMaxArea(), POINT_EDITOR::canAddCorner(), SCH_JUNCTION::CanConnect(), SCH_NO_CONNECT::CanConnect(), SCH_BUS_WIRE_ENTRY::CanConnect(), SCH_LINE::CanConnect(), SCH_BUS_BUS_ENTRY::CanConnect(), SCH_LABEL::CanConnect(), SCH_GLOBALLABEL::CanConnect(), SCH_HIERLABEL::CanConnect(), SCH_SHEET::CanConnect(), SCH_COMPONENT::CanConnect(), ROUTER_TOOL::CanInlineDrag(), SCH_SCREENS::ChangeSymbolLibNickname(), CN_VISITOR::checkZoneItemConnection(), TEXTE_PCB::ClassOf(), ClassOf(), BOARD_CONNECTED_ITEM::ClassOf(), PCB_TARGET::ClassOf(), TEXTE_MODULE::ClassOf(), DRAWSEGMENT::ClassOf(), ZONE_CONTAINER::ClassOf(), MARKER_PCB::ClassOf(), DIMENSION::ClassOf(), NETINFO_ITEM::ClassOf(), TRACK::ClassOf(), MODULE::ClassOf(), SCH_COMPONENT::ClassOf(), D_PAD::ClassOf(), BOARD::ClassOf(), VIA::ClassOf(), SCH_SHEET::CleanupSheet(), EE_COLLECTOR::Collect(), Collect_TrackSegmentsToDrag(), LIB_CIRCLE::compare(), LIB_RECTANGLE::compare(), LIB_BEZIER::compare(), LIB_POLYLINE::compare(), LIB_TEXT::compare(), LIB_ARC::compare(), LIB_FIELD::compare(), LIB_PIN::compare(), SCH_SHEET::ComponentCount(), GRID_HELPER::computeAnchors(), SCH_BUS_WIRE_ENTRY::ConnectionPropagatesTo(), SCH_EDIT_FRAME::ConvertTextType(), SCH_SCREEN::CountConnectedItems(), SCH_SHEET::CountSheets(), MODULE::CoverageRatio(), CINFO3D_VISU::createLayers(), 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(), SCH_SCREENS::DeleteAllMarkers(), SCH_SCREEN::DeleteItem(), DeleteNullTrackSegments(), DIALOG_LABEL_EDITOR::DIALOG_LABEL_EDITOR(), DIALOG_SCH_EDIT_ONE_FIELD::DIALOG_SCH_EDIT_ONE_FIELD(), DIALOG_TEXT_PROPERTIES::DIALOG_TEXT_PROPERTIES(), DIALOG_ERC::DisplayERC_MarkersList(), ALIGN_DISTRIBUTE_TOOL::doAlignLeft(), ALIGN_DISTRIBUTE_TOOL::doAlignRight(), ALIGN_DISTRIBUTE_TOOL::doDistributeCentersHorizontally(), ALIGN_DISTRIBUTE_TOOL::doDistributeCentersVertically(), ALIGN_DISTRIBUTE_TOOL::doDistributeGapsHorizontally(), ALIGN_DISTRIBUTE_TOOL::doDistributeGapsVertically(), DRC::doTrackDrc(), DRC::doTrackKeepoutDrc(), LIB_DRAWING_TOOLS::doTwoClickPlace(), KIGFX::SCH_PAINTER::draw(), KIGFX::GERBVIEW_PAINTER::Draw(), KIGFX::PCB_PAINTER::Draw(), KIGFX::PCB_PAINTER::draw(), DrawMovingBlockOutlines(), drawPickedItems(), CN_ITEM::Dump(), SCH_ITEM::Duplicate(), BOARD::Duplicate(), MODULE::Duplicate(), PCB_EDIT_FRAME::duplicateItems(), SCH_EDIT_FRAME::EditComponent(), SCH_EDIT_FRAME::EditComponentFieldText(), SCH_EDIT_TOOL::EditField(), LIB_EDIT_TOOL::editTextProperties(), EditToolSelectionFilter(), PCB_EDIT_FRAME::EraseRedundantTrack(), CONNECTION_GRAPH::ercCheckLabels(), 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(), EDIT_TOOL::FootprintFilter(), FootprintWriteShape(), SCH_LEGACY_PLUGIN::Format(), PCB_IO::Format(), PCB_IO::format(), FormatProbeItem(), POINT_EDITOR::get45DegConstrainer(), CN_ITEM::GetAnchor(), BOARD_ITEM::GetBoard(), TRACK::GetBoundingBox(), BOARD_CONNECTED_ITEM::GetClearance(), KIGFX::GERBVIEW_RENDER_SETTINGS::GetColor(), KIGFX::PCB_RENDER_SETTINGS::GetColor(), NETLIST_OBJECT::GetComponentParent(), SCH_MOVE_TOOL::getConnectedDragItems(), SCH_TEXT::GetConnectionPoints(), CONNECTION_SUBGRAPH::GetDriverPriority(), SCH_TEXT::GetEndPoints(), SCH_SHEET::GetEndPoints(), GetFirstTrack(), GetFirstVia(), SCH_SCREEN::GetHierarchicalItems(), SCH_SCREENS::GetLibNicknames(), TEXTE_PCB::GetMsgPanelInfo(), SCH_TEXT::GetMsgPanelInfo(), CONNECTION_SUBGRAPH::GetNameForDriver(), BOARD_CONNECTED_ITEM::GetNetClass(), CONNECTIVITY_DATA::GetNetItems(), LIB_PART::GetNextDrawItem(), DRAWSEGMENT::GetParentModule(), SCH_SCREEN::GetPin(), LIB_PART::GetPin(), SCH_COMPONENT::GetPinPhysicalPosition(), getRect(), SELECTION::GetTopLeftItem(), EE_SELECTION_TOOL::guessSelectionCandidates(), SELECTION_TOOL::guessSelectionCandidates(), hash_eda(), SCH_SCREENS::HasNoFullyDefinedLibIds(), SCH_SHEET::HasUndefinedPins(), EE_SELECTION_TOOL::highlight(), SELECTION_TOOL::highlight(), KIGFX::SCH_VIEW::HighlightItem(), SCH_EDIT_FRAME::ImportSheetPin(), SCH_EDIT_TOOL::Init(), ROUTER_TOOL::InlineBreakTrack(), ROUTER_TOOL::InlineDrag(), EE_COLLECTOR::Inspect(), SCH_FIND_COLLECTOR::Inspect(), GENERAL_COLLECTOR::Inspect(), PCB_LAYER_COLLECTOR::Inspect(), ARRAY_CREATOR::Invoke(), isNewSegment(), TRACK::IsNull(), SCH_LINE::IsParallel(), SCH_SCREEN::IsTerminalPoint(), BOARD_ITEM::IsTrack(), itemIsIncludedByFilter(), CLIPBOARD_IO::Load(), PNS_PCBNEW_RULE_RESOLVER::localPadClearance(), SCH_SHEET::LocatePathOfScreen(), Magnetize(), LIB_MOVE_TOOL::Main(), EE_SELECTION_TOOL::Main(), EDIT_POINTS_FACTORY::Make(), SCH_SCREEN::MarkConnections(), CN_CONNECTIVITY_ALGO::markItemNetAsDirty(), CONNECTIVITY_DATA::MarkItemNetAsDirty(), MarkItemsInBloc(), BOARD::MarkTrace(), TRACKS_CLEANER::mergeCollinearSegments(), TRACKS_CLEANER::MergeCollinearTracks(), SCH_LINE::MergeOverlap(), SCH_EDIT_TOOL::Mirror(), FOOTPRINT_EDIT_FRAME::ModeditLocateAndDisplay(), SCH_MOVE_TOOL::moveItem(), MoveMarkedItems(), MoveMarkedItemsExactly(), SCH_CONNECTION::Name(), FOOTPRINT_EDIT_FRAME::OnEditItemRequest(), PCB_EDIT_FRAME::OnEditItemRequest(), 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(), PCB_EDIT_FRAME::OnLeftClick(), PCB_EDIT_FRAME::OnLeftDClick(), FOOTPRINT_EDIT_FRAME::OnRightClick(), PCB_EDIT_FRAME::OnRightClick(), POINT_EDITOR::OnSelectionChange(), SCH_LINE::operator<(), LIB_ITEM::operator<(), SCH_ITEM::operator<(), SCH_COMPONENT::operator<(), SCH_BITMAP::operator=(), SCH_SHEET::operator=(), SCH_COMPONENT::operator=(), LIB_ITEM::operator==(), OrCell_Trace(), EDIT_TOOL::PadFilter(), BOARD_COMMIT::parentObject(), SCH_EDITOR_CONTROL::Paste(), PCBNEW_CONTROL::PasteItemsFromClipboard(), PCB_BASE_FRAME::PcbGeneralLocateAndDisplay(), DRAWING_TOOL::PlaceImportedGraphics(), SCH_FIELD::Plot(), BRDITEMS_PLOTTER::Plot_1_EdgeModule(), GAL_ARRAY_CREATOR::prePushAction(), PCB_EDIT_FRAME::Process_Special_Functions(), DIALOG_GLOBAL_EDIT_TRACKS_AND_VIAS::processItem(), DIALOG_EXCHANGE_FOOTPRINTS::processMatchingModules(), LIB_EDIT_TOOL::Properties(), SCH_EDIT_TOOL::Properties(), BOARD_COMMIT::Push(), PCB_BASE_EDIT_FRAME::PutDataInPreviousState(), SELECTION_TOOL::RebuildSelection(), SCH_BASE_FRAME::RefreshItem(), DIALOG_SYMBOL_REMAP::remapSymbolsToLibTable(), MODULE::Remove(), CN_CONNECTIVITY_ALGO::Remove(), BOARD::Remove(), POINT_EDITOR::removeCorner(), POINT_EDITOR::removeCornerCondition(), LIB_PART::RemoveDrawItem(), TRACKS_CLEANER::removeDuplicatesOfTrack(), SCH_SHEET::RemovePin(), FOOTPRINT_EDIT_FRAME::RemoveStruct(), PCB_EDIT_FRAME::RemoveStruct(), SCH_EDIT_TOOL::RepeatDrawItem(), SCH_SCREENS::ReplaceDuplicateTimeStamps(), SCH_SCREEN::ReplaceWires(), PCB_BASE_FRAME::ResetTextSize(), BOARD_COMMIT::Revert(), SCH_EDIT_TOOL::Rotate(), SCH_TEXT::Rotate(), SCH_LEGACY_PLUGIN_CACHE::saveArc(), SCH_LEGACY_PLUGIN_CACHE::saveBezier(), SCH_LEGACY_PLUGIN_CACHE::saveCircle(), PCB_BASE_EDIT_FRAME::SaveCopyInUndoList(), EE_TOOL_BASE< SCH_BASE_FRAME >::saveCopyInUndoList(), SCH_LEGACY_PLUGIN_CACHE::saveField(), SCH_LEGACY_PLUGIN_CACHE::savePin(), SCH_LEGACY_PLUGIN_CACHE::savePolyLine(), SCH_LEGACY_PLUGIN_CACHE::saveRectangle(), SCH_LEGACY_PLUGIN_CACHE::saveText(), SCH_EDIT_FRAME::SaveUndoItemInUndoList(), SCH_EDIT_FRAME::SchematicCleanUp(), SCH_SHEET::SearchHierarchy(), SELECTION_TOOL::select(), EE_SELECTION_TOOL::selectable(), SELECTION_TOOL::selectable(), PCB_EDIT_FRAME::SelectHighLight(), ITEM_PICKER::SetItem(), DIALOG_LABEL_EDITOR::SetTitle(), PCB_EDIT_FRAME::SetTrackSegmentWidth(), PCB_EDIT_FRAME::Show_1_Ratsnest(), Show_MoveNode(), ShowClearance(), ShowNewTrackWhenMovingCursor(), SortByTimeStamp(), PCB_EDIT_FRAME::Start_DragTrackSegmentAndKeepSlope(), PCB_EDIT_FRAME::StartMoveOneNodeOrSegment(), SCH_JUNCTION::SwapData(), SCH_NO_CONNECT::SwapData(), PCB_TARGET::SwapData(), SCH_BITMAP::SwapData(), SCH_SHEET_PIN::SwapData(), TEXTE_PCB::SwapData(), SCH_FIELD::SwapData(), DIMENSION::SwapData(), DRAWSEGMENT::SwapData(), TRACK::SwapData(), SCH_SHEET::SwapData(), VIA::SwapData(), SCH_COMPONENT::SwapData(), MODULE::SwapData(), ZONE_CONTAINER::SwapData(), D_PAD::SwapData(), SwapItemData(), PCB_EDIT_FRAME::SwitchLayer(), TestDuplicateSheetNames(), TRACKS_CLEANER::testTrackEndpointDangling(), TEXTE_MODULE::TEXTE_MODULE(), AR_MATRIX::TraceSegmentPcb(), TraceSegmentPcb(), DIALOG_LABEL_EDITOR::TransferDataFromWindow(), DIALOG_TEXT_PROPERTIES::TransferDataToWindow(), DIALOG_LABEL_EDITOR::TransferDataToWindow(), TRACK::TransformShapeWithClearanceToPolygon(), EE_SELECTION_TOOL::unhighlight(), SELECTION_TOOL::unhighlight(), SCH_SHEET_PATH::UpdateAllScreenReferences(), SCH_TEXT::UpdateDanglingState(), EE_POINT_EDITOR::updateItem(), POINT_EDITOR::updateItem(), CONNECTION_GRAPH::updateItemConnectivity(), EE_POINT_EDITOR::updatePoints(), POINT_EDITOR::updatePoints(), EE_TOOL_BASE< SCH_BASE_FRAME >::updateView(), PCB_BRIGHT_BOX::ViewDraw(), SCH_BUS_ENTRY_BASE::ViewGetLayers(), TRACK::Visit(), GERBER_DRAW_ITEM::Visit(), SCH_SHEET::Visit(), and SCH_COMPONENT::Visit().

◆ UnLink()

void BOARD_ITEM::UnLink ( )
virtualinherited

Function UnLink detaches this object from its owner.

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

Definition at line 54 of file class_board_item.cpp.

55 {
57  wxASSERT( list );
58 
59  if( list )
60  list->Remove( this );
61 }
DHEAD * GetList() const
Definition: base_struct.h:215
T * Remove(T *aElement)
Function Remove removes aElement from the list, but does not delete it.
Definition: dlist.h:211

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

Referenced by PCB_EDIT_FRAME::Block_Delete(), PCB_EDIT_FRAME::Delete_Segment_Edge(), PCB_EDIT_FRAME::Delete_Texte_Pcb(), PCB_EDIT_FRAME::DeleteDimension(), PCB_EDIT_FRAME::DeleteTarget(), and PCB_EDIT_FRAME::EraseRedundantTrack().

◆ ViewBBox()

const BOX2I DRAWSEGMENT::ViewBBox ( ) const
overridevirtualinherited

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

Returns
BOX2I - the current bounding box

Reimplemented from EDA_ITEM.

Definition at line 875 of file class_drawsegment.cpp.

876 {
877  // For arcs - do not include the center point in the bounding box,
878  // it is redundant for displaying an arc
879  if( m_Shape == S_ARC )
880  {
881  EDA_RECT bbox;
882  bbox.SetOrigin( m_End );
883  computeArcBBox( bbox );
884  return BOX2I( bbox.GetOrigin(), bbox.GetSize() );
885  }
886 
887  return EDA_ITEM::ViewBBox();
888 }
BOX2< VECTOR2I > BOX2I
Definition: box2.h:520
void SetOrigin(const wxPoint &pos)
Definition: eda_rect.h:124
void computeArcBBox(EDA_RECT &aBBox) const
wxPoint m_End
Line end point or circle and arc start point.
const wxPoint GetOrigin() const
Definition: eda_rect.h:112
Arcs (with rounded ends)
STROKE_T m_Shape
Shape: line, Circle, Arc.
Class EDA_RECT handles the component boundary box.
Definition: eda_rect.h:44
virtual const BOX2I ViewBBox() const override
Function ViewBBox() returns the bounding box of the item covering all its layers.
const wxSize GetSize() const
Definition: eda_rect.h:101

References DRAWSEGMENT::computeArcBBox(), EDA_RECT::GetOrigin(), EDA_RECT::GetSize(), DRAWSEGMENT::m_End, DRAWSEGMENT::m_Shape, S_ARC, EDA_RECT::SetOrigin(), and EDA_ITEM::ViewBBox().

◆ ViewDraw()

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

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

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

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

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

Definition at line 116 of file view_item.h.

117  {}

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

◆ ViewGetLayers()

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

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

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

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

Reimplemented from EDA_ITEM.

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

Definition at line 90 of file class_board_item.cpp.

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

References BOARD_ITEM::m_Layer.

Referenced by SELECTION_TOOL::selectable().

◆ ViewGetLOD()

unsigned int EDGE_MODULE::ViewGetLOD ( int  aLayer,
KIGFX::VIEW aView 
) const
overridevirtual

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

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

Parameters
aLayercurrent drawing layer
aViewpointer to the VIEW device we are drawing on
Returns
the level of detail. 0 always show the item, because the actual zoom level (or VIEW scale) is always > 0

Reimplemented from KIGFX::VIEW_ITEM.

Definition at line 459 of file class_edge_mod.cpp.

460 {
461  const int HIDE = std::numeric_limits<unsigned int>::max();
462 
463  if( !aView )
464  return 0;
465 
466  // Handle Render tab switches
467  if( !IsParentFlipped() && !aView->IsLayerVisible( LAYER_MOD_FR ) )
468  return HIDE;
469 
470  if( IsParentFlipped() && !aView->IsLayerVisible( LAYER_MOD_BK ) )
471  return HIDE;
472 
473  // Other layers are shown without any conditions
474  return 0;
475 }
show modules on front
bool IsParentFlipped() const
#define max(a, b)
Definition: auxiliary.h:86
bool IsLayerVisible(int aLayer) const
Function IsLayerVisible() Returns information about visibility of a particular layer.
Definition: view.h:427

References KIGFX::VIEW::IsLayerVisible(), IsParentFlipped(), LAYER_MOD_BK, LAYER_MOD_FR, and max.

◆ viewPrivData()

◆ Visit()

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

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

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

Parameters
inspectorAn INSPECTOR instance to use in the inspection.
testDataArbitrary data used by the inspector.
scanTypesWhich KICAD_T types are of interest and the order is significant too, terminated by EOT.
Returns
SEARCH_RESULT SEARCH_QUIT if the Iterator is to stop the scan, else SCAN_CONTINUE, and determined by the inspector.

Reimplemented in BOARD, LIB_PART, MODULE, SCH_COMPONENT, SCH_SHEET, GERBER_FILE_IMAGE, GERBER_DRAW_ITEM, TRACK, and GBR_LAYOUT.

Definition at line 149 of file base_struct.cpp.

150 {
151 #if 0 && defined(DEBUG)
152  std::cout << GetClass().mb_str() << ' ';
153 #endif
154 
155  if( IsType( scanTypes ) )
156  {
157  if( SEARCH_QUIT == inspector( this, testData ) )
158  return SEARCH_QUIT;
159  }
160 
161  return SEARCH_CONTINUE;
162 }
virtual bool IsType(const KICAD_T aScanTypes[])
Function IsType Checks whether the item is one of the listed types.
Definition: base_struct.h:287
virtual wxString GetClass() const =0
Function GetClass returns the class name.

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

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

Member Data Documentation

◆ m_Angle

◆ m_Bezier0_C1

wxPoint EDGE_MODULE::m_Bezier0_C1

Bezier Control Point 1, relative to module origin, orient 0.

Definition at line 145 of file class_edge_mod.h.

Referenced by Flip(), GetBezier0_C1(), Mirror(), Move(), SetBezier0_C1(), SetDrawCoord(), and SetLocalCoord().

◆ m_Bezier0_C2

wxPoint EDGE_MODULE::m_Bezier0_C2

Bezier Control Point 2, relative to module origin, orient 0.

Definition at line 146 of file class_edge_mod.h.

Referenced by Flip(), GetBezier0_C2(), Mirror(), Move(), SetBezier0_C2(), SetDrawCoord(), and SetLocalCoord().

◆ m_BezierC1

◆ m_BezierC2

◆ m_BezierPoints

◆ m_End

◆ m_End0

wxPoint EDGE_MODULE::m_End0

◆ m_Flags

◆ m_forceVisible

bool EDA_ITEM::m_forceVisible
protectedinherited

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

Definition at line 178 of file base_struct.h.

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

◆ m_Layer

◆ m_List

DHEAD* EDA_ITEM::m_List
protectedinherited

which DLIST I am on.

Definition at line 172 of file base_struct.h.

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

◆ m_Parent

◆ m_Poly

◆ m_Shape

◆ m_Start

◆ m_Start0

◆ m_TimeStamp

timestamp_t EDA_ITEM::m_TimeStamp
protectedinherited

◆ m_Type

int DRAWSEGMENT::m_Type
protectedinherited

Used in complex associations ( Dimensions.. )

Definition at line 54 of file class_drawsegment.h.

Referenced by DRAWSEGMENT::DRAWSEGMENT(), DRAWSEGMENT::GetType(), and DRAWSEGMENT::SetType().

◆ m_Width

◆ Pback

◆ Pnext

◆ ZeroOffset

wxPoint BOARD_ITEM::ZeroOffset
staticinherited

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

Definition at line 113 of file class_board_item.h.

Referenced by BOARD::GetPosition().


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